Updates the job work instruction list with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
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": "bf242dad-c5d3-4c8c-926a-c0e8a109dbfe",
"jobs_id": "f09e8ea9-d1d6-4e4f-ab67-58d6c0fd8271",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a09a9713-fda0-4bb4-a313-8e826d80591d",
"_parent_id": "f6be2341-8bf2-468c-9859-3c1dba231ea3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e01dce84-2ccd-4ba8-ac39-ee9a1e0d9473",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e242debd-7649-4555-ae50-2cf1de50b0a3",
"_parent_id": "a0f14fad-1769-431c-9cae-51b577df7af2",
"root_parent_id": "fba5324b-1f17-4f37-8aed-56e5ac54225f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "094d2878-4a64-4365-bda9-8c91a73581cd",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "23165568-8711-499d-b1cc-f7a6b86051a2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2b4bd1e3-9173-497e-a2c1-27a56ea9429f",
"_parent_code": "sample string 6",
"sales_organization_id": "7d8e5d10-226c-4607-8326-1cc7018e56b4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "770d1c6d-b611-48d3-a106-8b79800f8408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "664abe4f-3e67-4fc4-87ac-b027db9f1355",
"db_currency_id": "06149358-dbff-47fb-9984-ffe2eb4e71fe",
"db_language_id": "3f67a649-ab20-4785-b185-204998f06cd0",
"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": "2025-12-18T15:55:47.9897058+00:00"
},
"modified_dateutc": "2025-12-18T15:55:47.9897058+00:00"
},
"equipment_model_id": "c5626069-c2ae-487a-9593-5395f89325f8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0ebb90dc-d107-4ced-826c-88ab09c64232",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8fe70e91-2e42-4e32-834d-7aee8fde0cb3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "788acf3e-2aca-4795-8a3b-adf08be4443d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7910686d-24df-4569-9e54-d192fb80aec3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "770d1c6d-b611-48d3-a106-8b79800f8408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "664abe4f-3e67-4fc4-87ac-b027db9f1355",
"db_currency_id": "06149358-dbff-47fb-9984-ffe2eb4e71fe",
"db_language_id": "3f67a649-ab20-4785-b185-204998f06cd0",
"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": "2025-12-18T15:55:47.9897058+00:00"
},
"modified_dateutc": "2025-12-18T15:55:47.9897058+00:00"
},
"equipment_family_id": "fa7d4731-0366-49db-9ec5-b431c1c98f10",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "23165568-8711-499d-b1cc-f7a6b86051a2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2b4bd1e3-9173-497e-a2c1-27a56ea9429f",
"_parent_code": "sample string 6",
"sales_organization_id": "7d8e5d10-226c-4607-8326-1cc7018e56b4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "770d1c6d-b611-48d3-a106-8b79800f8408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "664abe4f-3e67-4fc4-87ac-b027db9f1355",
"db_currency_id": "06149358-dbff-47fb-9984-ffe2eb4e71fe",
"db_language_id": "3f67a649-ab20-4785-b185-204998f06cd0",
"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": "2025-12-18T15:55:47.9897058+00:00"
},
"modified_dateutc": "2025-12-18T15:55:47.9897058+00:00"
},
"date_in_production_since": "2025-12-18T15:55:47.9897058+00:00",
"date_out_of_production_since": "2025-12-18T15:55:47.9897058+00:00",
"date_end_support": "2025-12-18T15:55:47.9897058+00:00",
"sales_organization_id": "628c3a75-a074-4471-8f5b-3d1cf756e8bb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "770d1c6d-b611-48d3-a106-8b79800f8408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "664abe4f-3e67-4fc4-87ac-b027db9f1355",
"db_currency_id": "06149358-dbff-47fb-9984-ffe2eb4e71fe",
"db_language_id": "3f67a649-ab20-4785-b185-204998f06cd0",
"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": "2025-12-18T15:55:47.9897058+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": "2025-12-18T15:55:47.9897058+00:00"
},
"project_status_id": "e722a99b-af8f-4e0a-b135-b4097b1291a7",
"project_status_code": "sample string 10",
"project_status": {
"id": "7364a97a-1dcd-46bb-848b-45ba7ee51859",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "652d71f7-e178-4664-8139-419aec69c523",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "770d1c6d-b611-48d3-a106-8b79800f8408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "664abe4f-3e67-4fc4-87ac-b027db9f1355",
"db_currency_id": "06149358-dbff-47fb-9984-ffe2eb4e71fe",
"db_language_id": "3f67a649-ab20-4785-b185-204998f06cd0",
"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": "2025-12-18T15:55:47.9897058+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-18T15:55:47.9897058+00:00"
},
"company_id": "df80d543-f5b5-47d6-b880-edb797bba8e0",
"company_code": "sample string 12",
"db_address_id": "07c0f695-36cf-4134-a11c-ab6869943bdf",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "02298c06-a842-4c14-9580-af0ffc0c9d9e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "51caf7d3-1ed6-474b-a82f-140fc1e747f7",
"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": "2025-12-18T15:55:47.9897058+00:00",
"date_create": "2025-12-18T15:55:47.9897058+00:00",
"date_update": "2025-12-18T15:55:47.9897058+00:00",
"updated_by_user_id": "8ed8d07f-5d34-44c2-8890-f136d04f050a",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-18T15:55:47.9897058+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": "2025-12-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-18T15:55:47.9897058+00:00",
"date_last_job": "2025-12-18T15:55:47.9897058+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-18T15:55:47.9897058+00:00",
"modified_dateutc": "2025-12-18T15:55:47.9897058+00:00",
"is_mobile_installation": true
},
"job_type_id": "8c7e5a5d-6019-45d7-84e2-ec0599092814",
"job_type_code": "sample string 7",
"job_type": {
"id": "c612c3a3-09f7-4044-8c4e-9a03e7da6863",
"name": "sample string 2",
"sales_organization_id": "815508ae-270c-406a-b770-7069eb0373fc",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-18T15:55:47.9897058+00:00",
"code": "sample string 7"
},
"job_priority_id": "ec93bfbd-71f5-4800-ac4f-b59681606847",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1c6a8598-dd7e-4071-9d4d-764762470ee5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "bcdc7127-f3a5-4adf-8ec9-195efa3dbbb0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "770d1c6d-b611-48d3-a106-8b79800f8408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "664abe4f-3e67-4fc4-87ac-b027db9f1355",
"db_currency_id": "06149358-dbff-47fb-9984-ffe2eb4e71fe",
"db_language_id": "3f67a649-ab20-4785-b185-204998f06cd0",
"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": "2025-12-18T15:55:47.9897058+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-18T15:55:47.9897058+00:00"
},
"job_status_id": "99dc5b74-145c-4d8e-a182-3716287f3775",
"job_status_code": "sample string 11",
"db_address_id": "49682590-1fc0-4750-9f99-23d642c7a27e",
"contact_id": "2dcac09e-bf6d-415c-b040-2e7dfaf1b007",
"requested_by_company_id": "b8a1879e-3ac1-49c7-ba35-b28f2eb6b477",
"requested_by_contact_id": "b2637521-58dc-4a44-9156-b218bf26ce45",
"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": "2025-12-18T15:55:47.9897058+00:00",
"due_date": "2025-12-18T15:55:47.9897058+00:00",
"date_create": "2025-12-18T15:55:47.9897058+00:00",
"date_update": "2025-12-18T15:55:47.9897058+00:00",
"date_closed": "2025-12-18T15:55:47.9897058+00:00",
"suggested_user_id": "4e6ab38f-7caf-4b7e-ae6b-3e0d1bef6000",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b42f746a-cf15-48b3-9900-46445b6ad99f",
"db_language_id": "71f8786c-4427-4a6f-89d0-ca576d1a2a56",
"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": "2025-12-18T15:55:47.9897058+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fb8c94e2-b2d3-41cf-a5da-f088e696d01c",
"sales_organization": {
"id": "770d1c6d-b611-48d3-a106-8b79800f8408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "664abe4f-3e67-4fc4-87ac-b027db9f1355",
"db_currency_id": "06149358-dbff-47fb-9984-ffe2eb4e71fe",
"db_language_id": "3f67a649-ab20-4785-b185-204998f06cd0",
"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": "2025-12-18T15:55:47.9897058+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a5b484c0-6a5b-4991-ab92-9450afea7606",
"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": "1c9b612f-4adf-451a-8739-d5a156c0538f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-18T15:55:47.9897058+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "576275fd-031a-46f8-9ba7-93b17e4425ba"
},
"suggested_date_start": "2025-12-18T15:55:47.9897058+00:00",
"skill_id": "fe0cae52-d8be-4dab-862c-16ae8f97e899",
"skill_code": "sample string 32",
"skill": {
"id": "acaf31d6-0fea-458e-b5e7-997085fe6a44",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1656c5fa-82d5-4b7a-bbf2-f3b0b6b09661",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "770d1c6d-b611-48d3-a106-8b79800f8408",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "664abe4f-3e67-4fc4-87ac-b027db9f1355",
"db_currency_id": "06149358-dbff-47fb-9984-ffe2eb4e71fe",
"db_language_id": "3f67a649-ab20-4785-b185-204998f06cd0",
"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": "2025-12-18T15:55:47.9897058+00:00"
},
"modified_dateutc": "2025-12-18T15:55:47.9897058+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c81a2c48-ae90-4150-b1c1-b1491f27d205",
"date_reported_by_company": "2025-12-18T15:55:47.9897058+00:00",
"id2": 36,
"company_id": "c2250ee7-b615-4146-8708-c22a61a31ca4",
"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": "bc120288-6b20-431c-a3d1-f60b01eb5d2d",
"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": "2025-12-18T15:55:47.9897058+00:00"
},
"work_instruction_details_id": "d7eec362-58ac-49b6-ab6b-db1cec75244a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2505c96e-3e86-4baf-b7f3-ecf4f35e8a47",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6990fe85-6b52-44ce-a34a-80285ccd95db",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-18T15:55:47.9897058+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": "c7322bc6-2890-4d0e-8dcf-5743a096a55f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-18T15:55:47.9897058+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.