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": "3e2e63ef-f8e3-4eac-91a3-0b7757d1e564",
"jobs_id": "b36ef7ff-b253-44aa-86a7-9beabde6abdb",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a3eeeb50-4131-4243-8b6e-aec29bd00c51",
"_parent_id": "2d1d378e-727f-4090-a2df-8c7313a05ef0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7bfb3ffd-496e-4cb6-a41f-3c0e02ce19bd",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ff33f26b-c72f-466e-bb35-f58058103a4f",
"_parent_id": "0764ee7d-018f-4659-b5df-fc7bd4bd5149",
"root_parent_id": "77c7ff56-a641-409c-80c9-dd2c6d09dc2d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8816e343-f32e-46ec-869a-b86d9128f560",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "bb6524ab-6647-472d-90ca-b17f9bb5a449",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cd51bca9-041e-45b3-90c1-e3c084d400b9",
"_parent_code": "sample string 6",
"sales_organization_id": "e3254600-2c92-4a42-b045-5872e237cf91",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e76aebcf-dd34-4780-8517-30ce98537dfd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e932f01-512e-4666-bf83-1a421a231611",
"db_currency_id": "dc61a309-06d6-4711-9d67-2896cac75d2c",
"db_language_id": "72d30d56-24dc-4a2a-9425-8b7c3ac6bd7c",
"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-05-14T10:21:22.9604083+00:00"
},
"modified_dateutc": "2026-05-14T10:21:22.9604083+00:00"
},
"equipment_model_id": "0b25c1e7-e0cd-4c2e-aa14-def81ccecade",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a9d2a542-96bb-4db6-9f22-1ef3ce6ee186",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1a2de294-248d-4d6c-b7da-a54b61015991",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "96bdeac3-456e-42e2-9034-8bc36ef304c4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "934bee69-5f63-45c8-bd62-bb7fd57443e9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e76aebcf-dd34-4780-8517-30ce98537dfd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e932f01-512e-4666-bf83-1a421a231611",
"db_currency_id": "dc61a309-06d6-4711-9d67-2896cac75d2c",
"db_language_id": "72d30d56-24dc-4a2a-9425-8b7c3ac6bd7c",
"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-05-14T10:21:22.9604083+00:00"
},
"modified_dateutc": "2026-05-14T10:21:22.9604083+00:00"
},
"equipment_family_id": "e9959262-e7af-4750-adba-416bb474ea9b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "bb6524ab-6647-472d-90ca-b17f9bb5a449",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cd51bca9-041e-45b3-90c1-e3c084d400b9",
"_parent_code": "sample string 6",
"sales_organization_id": "e3254600-2c92-4a42-b045-5872e237cf91",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e76aebcf-dd34-4780-8517-30ce98537dfd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e932f01-512e-4666-bf83-1a421a231611",
"db_currency_id": "dc61a309-06d6-4711-9d67-2896cac75d2c",
"db_language_id": "72d30d56-24dc-4a2a-9425-8b7c3ac6bd7c",
"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-05-14T10:21:22.9604083+00:00"
},
"modified_dateutc": "2026-05-14T10:21:22.9604083+00:00"
},
"date_in_production_since": "2026-05-14T10:21:22.9604083+00:00",
"date_out_of_production_since": "2026-05-14T10:21:22.9604083+00:00",
"date_end_support": "2026-05-14T10:21:22.9604083+00:00",
"sales_organization_id": "d01f48dd-37ed-4f5f-8c6e-46d73375fdec",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e76aebcf-dd34-4780-8517-30ce98537dfd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e932f01-512e-4666-bf83-1a421a231611",
"db_currency_id": "dc61a309-06d6-4711-9d67-2896cac75d2c",
"db_language_id": "72d30d56-24dc-4a2a-9425-8b7c3ac6bd7c",
"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-05-14T10:21:22.9604083+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-05-14T10:21:22.9604083+00:00"
},
"project_status_id": "b38805fa-d2ed-4d36-8982-b3322eb488c3",
"project_status_code": "sample string 10",
"project_status": {
"id": "a2bc0842-cfc2-4a1a-8c7d-791283ff79db",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c1a58852-61a7-4932-9da5-abfb22c13b00",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e76aebcf-dd34-4780-8517-30ce98537dfd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e932f01-512e-4666-bf83-1a421a231611",
"db_currency_id": "dc61a309-06d6-4711-9d67-2896cac75d2c",
"db_language_id": "72d30d56-24dc-4a2a-9425-8b7c3ac6bd7c",
"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-05-14T10:21:22.9604083+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-14T10:21:22.9604083+00:00"
},
"company_id": "6d6adea1-31bf-4ad3-a994-19d293baefb3",
"company_code": "sample string 12",
"db_address_id": "259dcd52-fe66-41e9-8b49-056c7a81a528",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "237163fd-5933-4343-891f-04af3ebba78e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "39f013ea-fc4a-4a37-8ca8-4b65dfebf2b1",
"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-05-14T10:21:22.9604083+00:00",
"date_create": "2026-05-14T10:21:22.9604083+00:00",
"date_update": "2026-05-14T10:21:22.9604083+00:00",
"updated_by_user_id": "2c35c841-2d66-41f8-8fb8-97141be47493",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-14T10:21:22.9604083+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-05-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-14T10:21:22.9604083+00:00",
"date_last_job": "2026-05-14T10:21:22.9604083+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-14T10:21:22.9604083+00:00",
"modified_dateutc": "2026-05-14T10:21:22.9604083+00:00",
"is_mobile_installation": true
},
"job_type_id": "af13a4db-6dc5-4751-9b09-b68cafa29a6e",
"job_type_code": "sample string 7",
"job_type": {
"id": "8f85da37-d276-4ec1-a056-ec5c4faa5f46",
"name": "sample string 2",
"sales_organization_id": "219f1593-2a9e-4eec-b1b7-e1c9c3f52402",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-14T10:21:22.9604083+00:00",
"code": "sample string 7"
},
"job_priority_id": "88970feb-8b69-489d-9a7b-f28da59a7865",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "cda7f96a-0cba-40db-b830-dfcdc3f19ecb",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3c61e73b-4911-43bb-8113-d059c6cb7c95",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e76aebcf-dd34-4780-8517-30ce98537dfd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e932f01-512e-4666-bf83-1a421a231611",
"db_currency_id": "dc61a309-06d6-4711-9d67-2896cac75d2c",
"db_language_id": "72d30d56-24dc-4a2a-9425-8b7c3ac6bd7c",
"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-05-14T10:21:22.9604083+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-14T10:21:22.9604083+00:00"
},
"job_status_id": "f48322a4-ed83-4495-a06a-2046a94a0b17",
"job_status_code": "sample string 11",
"db_address_id": "d32bf57f-45f5-460e-a40b-e415b2eac4b0",
"contact_id": "45aa2149-e217-4c33-a2c7-bf84f65c0de1",
"requested_by_company_id": "e9876e7e-c00d-498f-b3f6-d23872d72bd2",
"requested_by_contact_id": "c072f507-0607-4b44-89d6-8b2fb791b7a8",
"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-05-14T10:21:22.9604083+00:00",
"due_date": "2026-05-14T10:21:22.9604083+00:00",
"date_create": "2026-05-14T10:21:22.9604083+00:00",
"date_update": "2026-05-14T10:21:22.9604083+00:00",
"date_closed": "2026-05-14T10:21:22.9604083+00:00",
"suggested_user_id": "d303f044-b0e3-4164-9afa-59a59af0fe6f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d77bcbdb-19d9-4697-b1ce-f5362d8bfbda",
"db_language_id": "ae8cbf9b-92d4-4ecc-93e9-46af71bca9f6",
"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-05-14T10:21:22.9604083+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d96f0471-3a3f-453c-a216-07c929c39d1c",
"sales_organization": {
"id": "e76aebcf-dd34-4780-8517-30ce98537dfd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e932f01-512e-4666-bf83-1a421a231611",
"db_currency_id": "dc61a309-06d6-4711-9d67-2896cac75d2c",
"db_language_id": "72d30d56-24dc-4a2a-9425-8b7c3ac6bd7c",
"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-05-14T10:21:22.9604083+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b8481d7c-687d-4c88-bb0f-a6044da4f073",
"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": "4326402d-10fd-4f77-baf0-cf2840a7c720",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-14T10:21:22.9604083+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "67e65396-77a1-42df-9fc8-555c154303e1"
},
"suggested_date_start": "2026-05-14T10:21:22.9604083+00:00",
"skill_id": "8ebb6ab6-bf22-46a4-b767-5d144c8d7743",
"skill_code": "sample string 32",
"skill": {
"id": "3289d3bd-9390-4d12-b967-1ba15ebf615e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bf8b5b7b-3a80-40fa-9633-48c584872ff4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e76aebcf-dd34-4780-8517-30ce98537dfd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6e932f01-512e-4666-bf83-1a421a231611",
"db_currency_id": "dc61a309-06d6-4711-9d67-2896cac75d2c",
"db_language_id": "72d30d56-24dc-4a2a-9425-8b7c3ac6bd7c",
"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-05-14T10:21:22.9604083+00:00"
},
"modified_dateutc": "2026-05-14T10:21:22.9604083+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c4c97bae-3bb7-4096-88c9-86ce01988419",
"date_reported_by_company": "2026-05-14T10:21:22.9604083+00:00",
"id2": 36,
"company_id": "b46f279d-ef11-40e3-b099-00909fd9d4d1",
"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": "61a91994-0197-4641-9a3a-f379455626c4",
"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-05-14T10:21:22.9604083+00:00"
},
"work_instruction_details_id": "9dbda0a3-67ac-4a61-9dbb-227425748406",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d9639c29-21fa-4a52-8f65-f77cb2aca2b5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fd08df2d-39f2-4401-8be1-580584824f9b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-14T10:21:22.9604083+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": "99d045b2-5696-4152-85bc-87d5e44ba2e5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-14T10:21:22.9604083+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.