Creates a new job work instruction list.
Request Information
URI Parameters :
None.
Body Parameters :
job_work_instruction_list| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
Primary Key |
globally unique identifier |
Required |
| jobs_id |
Foreign key of the jobs |
globally unique identifier |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs_reference_back_office |
Embedded entity "jobs" using ERP PK when adding/updating |
string |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| jobs |
Embedded entity "jobs" when adding/updating |
jobs |
Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided |
| work_instruction_details_id |
work instruction details id |
globally unique identifier | |
| work_instruction_details_reference_back_office |
Embedded code "work instruction details" when adding/updating |
string | |
| work_instruction_details |
Embedded entity "work instruction details" when adding/updating |
work_instruction_details | |
| user_id |
Filled by the person that completed that item on the checklist |
globally unique identifier | |
| work_instruction_action_type |
Value from work_instruction_action_type.name |
string | |
| work_instruction_id |
work instruction id |
globally unique identifier |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction_reference_back_office |
Embedded code "work instruction" when adding/updating |
string |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| work_instruction |
Embedded entity "work instruction" when adding/updating |
work_instruction |
Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided |
| name |
The "on what" |
string |
Required Max length: 4000 |
| status |
Status can be Ok,NotOk,Replaced,NotApplicable |
string |
Max length: 50 |
| date_done |
Datetime filled when status goes to one valable status. |
date | |
| remark |
Additional remark from the technician. |
string |
Max length: 255 |
| advise |
Additional advice from the technician. |
string |
Max length: 255 |
| sequence |
To order it. |
integer | |
| reference_back_office |
The Id/Ref of the back office for this job work instruction. Used by Embedded entity |
string |
Max length: 255 |
| group_name |
Name of the group |
string |
Max length: 4000 |
| group_sequence |
Order of the group |
integer | |
| type |
One of the possible types which are Regular, Form, Picture, UsedParts, BillableHours. Regular is the default |
string | |
| instruction_document_count |
Specify how many documents/photos must be added if type is Picture |
integer | |
| db_report_type_id |
When type is Form, you must specify which db_report_type must be filled |
globally unique identifier | |
| db_report_type_name |
When type is Form, you must specify which db_report_type must be filled |
string | |
| modified_dateutc |
Readonly system field managed by database, filled with GetUtcDate when adding,updating |
date |
Request Formats :
application/json, text/json
Sample:
{
"id": "f7e18fba-c6f5-4739-b1ce-ce2e222ea75e",
"jobs_id": "0e44d613-d954-4846-b286-2f440e92ad0d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5d7b21aa-f694-4af9-b51f-1a4923c0ff8a",
"_parent_id": "9ae16e1d-2abb-44a1-9bd5-ef841fbaf0e6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b1944f89-fc40-4826-ba49-e69caf754779",
"project_reference_back_office": "sample string 5",
"project": {
"id": "aeae6f9a-346c-41c8-a6a2-f37906ba833c",
"_parent_id": "49e9754a-a701-4c32-9dcf-c3f42ba4fc85",
"root_parent_id": "d22a2257-0269-432e-99ac-fcceaac3ce78",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2f98397b-72b1-4b74-bc87-0241a84e2510",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "26bf2769-f769-4bc8-9bfa-07bd9d0d3aa6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8c60ffc1-e3a8-4b4d-adf3-3967cdcb87ef",
"_parent_code": "sample string 6",
"sales_organization_id": "309dc60f-89f5-4742-9f32-c22bc624da18",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9a8f7568-267c-4271-9127-764259281d8b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c8c43df0-ef74-4b98-9cc0-8ae0ee564c39",
"db_currency_id": "10bc5873-16d2-4186-aa8b-abef49868a25",
"db_language_id": "cbf74cf1-9642-48e7-95bb-8ef66c496bf3",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-01-13T12:35:13.4100301+00:00"
},
"modified_dateutc": "2026-01-13T12:35:13.4100301+00:00"
},
"equipment_model_id": "b958ea71-21b2-4114-b882-3700d57c07c7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "837c6684-e368-4f00-ac0d-634edee8c61e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "066518df-8d23-46d4-b953-8fa53eae7869",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0be40fab-b44a-407c-8a08-29ff68c1fb7a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fda99697-8e5b-4d9a-affd-29ccc3930504",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9a8f7568-267c-4271-9127-764259281d8b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c8c43df0-ef74-4b98-9cc0-8ae0ee564c39",
"db_currency_id": "10bc5873-16d2-4186-aa8b-abef49868a25",
"db_language_id": "cbf74cf1-9642-48e7-95bb-8ef66c496bf3",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-01-13T12:35:13.4100301+00:00"
},
"modified_dateutc": "2026-01-13T12:35:13.4100301+00:00"
},
"equipment_family_id": "2ca4ef33-b9b3-4510-beff-54062eb4b967",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "26bf2769-f769-4bc8-9bfa-07bd9d0d3aa6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8c60ffc1-e3a8-4b4d-adf3-3967cdcb87ef",
"_parent_code": "sample string 6",
"sales_organization_id": "309dc60f-89f5-4742-9f32-c22bc624da18",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9a8f7568-267c-4271-9127-764259281d8b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c8c43df0-ef74-4b98-9cc0-8ae0ee564c39",
"db_currency_id": "10bc5873-16d2-4186-aa8b-abef49868a25",
"db_language_id": "cbf74cf1-9642-48e7-95bb-8ef66c496bf3",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-01-13T12:35:13.4100301+00:00"
},
"modified_dateutc": "2026-01-13T12:35:13.4100301+00:00"
},
"date_in_production_since": "2026-01-13T12:35:13.4100301+00:00",
"date_out_of_production_since": "2026-01-13T12:35:13.4100301+00:00",
"date_end_support": "2026-01-13T12:35:13.4100301+00:00",
"sales_organization_id": "94c2aee6-2f95-482b-97db-28e3f4bc8ff8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9a8f7568-267c-4271-9127-764259281d8b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c8c43df0-ef74-4b98-9cc0-8ae0ee564c39",
"db_currency_id": "10bc5873-16d2-4186-aa8b-abef49868a25",
"db_language_id": "cbf74cf1-9642-48e7-95bb-8ef66c496bf3",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-01-13T12:35:13.4100301+00:00"
},
"replacement_period_nb_months": 14,
"warranty_period_nb_months": 15,
"translations": [
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
},
{
"field_name": "sample string 1",
"language_code": "sample string 2",
"value_translated": "sample string 3"
}
],
"modified_dateutc": "2026-01-13T12:35:13.4100301+00:00"
},
"project_status_id": "81294de0-7a2d-416a-9487-b110765257a6",
"project_status_code": "sample string 10",
"project_status": {
"id": "b7faccd6-d138-4447-8371-e65a79c36406",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d8c7b4dc-7785-456d-a434-959761e6f58e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9a8f7568-267c-4271-9127-764259281d8b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c8c43df0-ef74-4b98-9cc0-8ae0ee564c39",
"db_currency_id": "10bc5873-16d2-4186-aa8b-abef49868a25",
"db_language_id": "cbf74cf1-9642-48e7-95bb-8ef66c496bf3",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-01-13T12:35:13.4100301+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-13T12:35:13.4100301+00:00"
},
"company_id": "d26eed74-f279-44af-8885-9b5dec5d8034",
"company_code": "sample string 12",
"db_address_id": "3d2be328-8195-4776-bcad-2f6c36663e1d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "62b39586-2ecc-4a6b-b8e2-86a6b42dab96",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5e2c22ed-38cb-4328-9e3a-cd881bc88901",
"name": "sample string 19",
"description": "sample string 20",
"reference_back_office": "sample string 21",
"serial_number": "sample string 22",
"barcode": "sample string 23",
"date_start_production": "2026-01-13T12:35:13.4100301+00:00",
"date_create": "2026-01-13T12:35:13.4100301+00:00",
"date_update": "2026-01-13T12:35:13.4100301+00:00",
"updated_by_user_id": "a77c3394-5818-47a4-93d2-515d55d27030",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-13T12:35:13.4100301+00:00",
"last_standard_result_score_1": "sample string 30",
"last_standard_result_score_2": "sample string 31",
"target_standard_result_score_1": "sample string 32",
"target_standard_result_score_2": "sample string 33",
"date_built": "2026-01-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-13T12:35:13.4100301+00:00",
"date_last_job": "2026-01-13T12:35:13.4100301+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-13T12:35:13.4100301+00:00",
"modified_dateutc": "2026-01-13T12:35:13.4100301+00:00",
"is_mobile_installation": true
},
"job_type_id": "9d75c1c7-a677-4868-8d41-49c8f4013290",
"job_type_code": "sample string 7",
"job_type": {
"id": "4ac4112e-f964-4589-8c0f-8775fd0adbfe",
"name": "sample string 2",
"sales_organization_id": "9c9afec3-8364-4cb8-bbb5-fa574f9c11be",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-13T12:35:13.4100301+00:00",
"code": "sample string 7"
},
"job_priority_id": "e05d6019-3b5a-429b-be5b-1834c1fa8327",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0b8bd6e8-61cf-4bd9-a603-0dbfdfe211ad",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b2593116-500c-4eb3-b508-7b4e089f7bf0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9a8f7568-267c-4271-9127-764259281d8b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c8c43df0-ef74-4b98-9cc0-8ae0ee564c39",
"db_currency_id": "10bc5873-16d2-4186-aa8b-abef49868a25",
"db_language_id": "cbf74cf1-9642-48e7-95bb-8ef66c496bf3",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-01-13T12:35:13.4100301+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-13T12:35:13.4100301+00:00"
},
"job_status_id": "5c97d19b-a7ee-48dd-9d42-a50b8c91dd2c",
"job_status_code": "sample string 11",
"db_address_id": "000f71ee-dbf0-4ec8-b99c-5f3c4b8cac64",
"contact_id": "76c135a6-9eef-4f27-b0e9-9f8ad80b622f",
"requested_by_company_id": "09c89435-b017-4f4a-a786-db960736861b",
"requested_by_contact_id": "a96b923d-348a-440d-953e-69c500d76a94",
"reference_back_office": "sample string 16",
"name": "sample string 17",
"description": "sample string 18",
"working_sequence": 19,
"internal_memo": "sample string 20",
"prejob_information": "sample string 21",
"estimated_time": 22,
"earliest_date_plannable": "2026-01-13T12:35:13.4100301+00:00",
"due_date": "2026-01-13T12:35:13.4100301+00:00",
"date_create": "2026-01-13T12:35:13.4100301+00:00",
"date_update": "2026-01-13T12:35:13.4100301+00:00",
"date_closed": "2026-01-13T12:35:13.4100301+00:00",
"suggested_user_id": "3508e69a-9cae-4d05-9efd-ed7822ef3155",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "dfcf988a-855d-4536-9c9b-033959356aae",
"db_language_id": "3298aafb-0654-4745-9eb9-2865b8b278ce",
"username": "sample string 3",
"firstname": "sample string 4",
"lastname": "sample string 5",
"code": "sample string 6",
"archived": true,
"disabled": true,
"emergency_contact": "sample string 9",
"bankaccount": "sample string 10",
"social_security": "sample string 11",
"place_of_birth": "sample string 12",
"nationality": "sample string 13",
"functions": "sample string 14",
"birthdate": "2026-01-13T12:35:13.4100301+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "13d1423a-f245-479d-872a-51eb6f6b5a69",
"sales_organization": {
"id": "9a8f7568-267c-4271-9127-764259281d8b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c8c43df0-ef74-4b98-9cc0-8ae0ee564c39",
"db_currency_id": "10bc5873-16d2-4186-aa8b-abef49868a25",
"db_language_id": "cbf74cf1-9642-48e7-95bb-8ef66c496bf3",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-01-13T12:35:13.4100301+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f061d2de-9f33-407f-9317-d6f726575060",
"email": "sample string 22",
"phone": "sample string 23",
"fax": "sample string 24",
"mobile": "sample string 25",
"private_email": "sample string 26",
"private_phone": "sample string 27",
"private_fax": "sample string 28",
"private_mobile": "sample string 29",
"private_street": "sample string 30",
"private_street_number": "sample string 31",
"private_city": "sample string 32",
"private_zip": "sample string 33",
"private_db_country_id": "05af7d99-d926-4c08-86d5-fbd3621d82e1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-13T12:35:13.4100301+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "017cf576-b07b-4fd1-b573-f36fa1a8cc78"
},
"suggested_date_start": "2026-01-13T12:35:13.4100301+00:00",
"skill_id": "7637bfb5-c4ad-4c42-a6be-d243d4ee2d2b",
"skill_code": "sample string 32",
"skill": {
"id": "baf9f08d-6355-4f5c-9d5d-1f373ace542f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1b47d46a-622d-4489-8284-b5a01ccf097d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9a8f7568-267c-4271-9127-764259281d8b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c8c43df0-ef74-4b98-9cc0-8ae0ee564c39",
"db_currency_id": "10bc5873-16d2-4186-aa8b-abef49868a25",
"db_language_id": "cbf74cf1-9642-48e7-95bb-8ef66c496bf3",
"accountancy_code": "sample string 8",
"archived": true,
"default_unit_of_measure_system_type": "sample string 10",
"street": "sample string 11",
"street2": "sample string 12",
"street_number": "sample string 13",
"zip": "sample string 14",
"city": "sample string 15",
"email": "sample string 16",
"phone": "sample string 17",
"fax": "sample string 18",
"url": "sample string 19",
"vat_reg_code": "sample string 20",
"modified_dateutc": "2026-01-13T12:35:13.4100301+00:00"
},
"modified_dateutc": "2026-01-13T12:35:13.4100301+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "564ab078-daf9-4f90-b255-4e120341b252",
"date_reported_by_company": "2026-01-13T12:35:13.4100301+00:00",
"id2": 36,
"company_id": "a1085b13-80ce-4fa8-8267-b3e9e975a107",
"company_code": "sample string 38",
"db_address_name": "sample string 39",
"db_address_street": "sample string 40",
"db_address_street2": "sample string 41",
"db_address_street_number": "sample string 42",
"db_address_city": "sample string 43",
"db_address_zip": "sample string 44",
"db_address_db_country_id": "3482a09b-8d66-4964-8d0d-689f5f9eaf50",
"db_address_db_country_code": "sample string 46",
"db_address_phone": "sample string 47",
"db_address_email": "sample string 48",
"db_address_latitude_decimal": 49.0,
"db_address_longitude_decimal": 50.0,
"estimated_quantity_remark": "sample string 51",
"modified_dateutc": "2026-01-13T12:35:13.4100301+00:00"
},
"work_instruction_details_id": "15feea29-350b-4057-b0bf-749dbf11f2c5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e22e736b-f06e-4bf2-b505-788660fd0d9d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5ec15084-64ef-4c7b-a7f9-203f90168ed0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-13T12:35:13.4100301+00:00",
"remark": "sample string 13",
"advise": "sample string 14",
"sequence": 1,
"reference_back_office": "sample string 15",
"group_name": "sample string 16",
"group_sequence": 1,
"type": "sample string 17",
"instruction_document_count": 1,
"db_report_type_id": "f25e995e-df58-48e1-8745-fbb01c15f02d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-13T12:35:13.4100301+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.