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": "bcd8a16c-8e0c-41ce-ac31-1ec7d2191b90",
"jobs_id": "dce51aa8-1002-4d70-babc-c98658f856fe",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e7002044-a9e6-4594-b1e4-7eaeae6812d9",
"_parent_id": "8e5535b2-e1c8-485e-8793-ab0141eea65d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "69aad1f2-16b3-4324-ae3a-61d2f736a223",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4c583131-18fa-4748-8de4-699cb0be6039",
"_parent_id": "9105d51f-5a62-4e71-869a-5d30fc42bf79",
"root_parent_id": "54b2cb5a-5c6b-41c1-a9c2-737bc4c2a878",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fb8059fd-1191-47c8-8881-3e087d90fb27",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "aef09dd1-5851-4b40-8aa5-8c19d49b579d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9416002d-1c15-4d45-b49e-870c657dc85a",
"_parent_code": "sample string 6",
"sales_organization_id": "9cf51374-625a-4cad-941b-2a29fb6301fd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "39461043-64c5-454c-80ad-0d8fc13c3eff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0338c77-9c2a-4363-ad4c-8710b051e9e5",
"db_currency_id": "e4b807d9-8154-416f-bc6f-75dfbbd5f0fe",
"db_language_id": "ff6b8d0c-b739-4fa1-877c-d8ff6e5166c2",
"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-16T02:24:56.4670981+00:00"
},
"modified_dateutc": "2026-05-16T02:24:56.4670981+00:00"
},
"equipment_model_id": "c60e7698-c81e-426b-9075-ce16f530fc1d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ca75fe06-2dd7-44a4-8b7e-d11669cd0d3a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "cd2827ca-c536-46df-bee9-9ab69591328d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ac6f840d-a349-4c49-b61a-c4a743a6ad31",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "59f0c1a8-7322-4b6e-8688-9d594410697b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "39461043-64c5-454c-80ad-0d8fc13c3eff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0338c77-9c2a-4363-ad4c-8710b051e9e5",
"db_currency_id": "e4b807d9-8154-416f-bc6f-75dfbbd5f0fe",
"db_language_id": "ff6b8d0c-b739-4fa1-877c-d8ff6e5166c2",
"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-16T02:24:56.4670981+00:00"
},
"modified_dateutc": "2026-05-16T02:24:56.4670981+00:00"
},
"equipment_family_id": "03a7d4ca-de6f-4324-ab40-209ec3f3b7bb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "aef09dd1-5851-4b40-8aa5-8c19d49b579d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9416002d-1c15-4d45-b49e-870c657dc85a",
"_parent_code": "sample string 6",
"sales_organization_id": "9cf51374-625a-4cad-941b-2a29fb6301fd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "39461043-64c5-454c-80ad-0d8fc13c3eff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0338c77-9c2a-4363-ad4c-8710b051e9e5",
"db_currency_id": "e4b807d9-8154-416f-bc6f-75dfbbd5f0fe",
"db_language_id": "ff6b8d0c-b739-4fa1-877c-d8ff6e5166c2",
"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-16T02:24:56.4670981+00:00"
},
"modified_dateutc": "2026-05-16T02:24:56.4670981+00:00"
},
"date_in_production_since": "2026-05-16T02:24:56.4670981+00:00",
"date_out_of_production_since": "2026-05-16T02:24:56.4670981+00:00",
"date_end_support": "2026-05-16T02:24:56.4670981+00:00",
"sales_organization_id": "7374ff0b-737c-4016-8684-4971927ce42e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "39461043-64c5-454c-80ad-0d8fc13c3eff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0338c77-9c2a-4363-ad4c-8710b051e9e5",
"db_currency_id": "e4b807d9-8154-416f-bc6f-75dfbbd5f0fe",
"db_language_id": "ff6b8d0c-b739-4fa1-877c-d8ff6e5166c2",
"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-16T02:24:56.4670981+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-16T02:24:56.48272+00:00"
},
"project_status_id": "17dd0f6f-0681-496b-995d-7236ceb536e0",
"project_status_code": "sample string 10",
"project_status": {
"id": "1c7ca4ce-ee36-40bf-89c5-dbb8844c5488",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ea8042f8-c418-411c-9330-b40205c1dab2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "39461043-64c5-454c-80ad-0d8fc13c3eff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0338c77-9c2a-4363-ad4c-8710b051e9e5",
"db_currency_id": "e4b807d9-8154-416f-bc6f-75dfbbd5f0fe",
"db_language_id": "ff6b8d0c-b739-4fa1-877c-d8ff6e5166c2",
"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-16T02:24:56.4670981+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-16T02:24:56.48272+00:00"
},
"company_id": "73ba871c-fe6a-4b7b-97fd-ba356d2fd23e",
"company_code": "sample string 12",
"db_address_id": "3e018cc1-14ed-4396-98e1-0d187d0a7608",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7aa2315c-bd3d-4dce-91db-43ddc2fc30bc",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e38286df-a6de-41aa-a391-be9d85748284",
"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-16T02:24:56.48272+00:00",
"date_create": "2026-05-16T02:24:56.48272+00:00",
"date_update": "2026-05-16T02:24:56.48272+00:00",
"updated_by_user_id": "753d27c3-28c9-4b49-987b-443871d9f858",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-16T02:24:56.48272+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-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-16T02:24:56.48272+00:00",
"date_last_job": "2026-05-16T02:24:56.48272+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-16T02:24:56.48272+00:00",
"modified_dateutc": "2026-05-16T02:24:56.48272+00:00",
"is_mobile_installation": true
},
"job_type_id": "7cd190de-64a5-4a63-9a9b-e87d5b1a2dd9",
"job_type_code": "sample string 7",
"job_type": {
"id": "fca541b8-bb65-4b18-829c-61e674ff3644",
"name": "sample string 2",
"sales_organization_id": "14067f98-b203-44a4-8df7-7643c00b847f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-16T02:24:56.48272+00:00",
"code": "sample string 7"
},
"job_priority_id": "b80824ef-442b-4513-98c6-569f5820a21d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bed6c00c-e61f-482a-a278-0122d3f43467",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9fdd6023-1a0e-47be-8146-9dcef917f45c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "39461043-64c5-454c-80ad-0d8fc13c3eff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0338c77-9c2a-4363-ad4c-8710b051e9e5",
"db_currency_id": "e4b807d9-8154-416f-bc6f-75dfbbd5f0fe",
"db_language_id": "ff6b8d0c-b739-4fa1-877c-d8ff6e5166c2",
"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-16T02:24:56.4670981+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-16T02:24:56.48272+00:00"
},
"job_status_id": "7a56244f-f7f1-413a-9716-951999286b79",
"job_status_code": "sample string 11",
"db_address_id": "d9d8d358-d428-462b-aff9-fc6033ca476d",
"contact_id": "dbdb8ef5-b21c-4e16-908b-aec2e97b59ad",
"requested_by_company_id": "89e4a874-adb3-4510-8bf0-766890cdd83a",
"requested_by_contact_id": "98e96789-8cba-4b74-8632-e35ec360ca9a",
"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-16T02:24:56.48272+00:00",
"due_date": "2026-05-16T02:24:56.48272+00:00",
"date_create": "2026-05-16T02:24:56.48272+00:00",
"date_update": "2026-05-16T02:24:56.48272+00:00",
"date_closed": "2026-05-16T02:24:56.48272+00:00",
"suggested_user_id": "22167170-62bf-4b1d-a50e-7db3ad6f2248",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cc7c135a-fd31-40bf-bcb7-829e4d7ccd74",
"db_language_id": "87105eed-d489-4ec2-96ac-c48fdb76720f",
"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-16T02:24:56.48272+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1c758f90-b893-4ab1-8829-33d4a52f9ee5",
"sales_organization": {
"id": "39461043-64c5-454c-80ad-0d8fc13c3eff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0338c77-9c2a-4363-ad4c-8710b051e9e5",
"db_currency_id": "e4b807d9-8154-416f-bc6f-75dfbbd5f0fe",
"db_language_id": "ff6b8d0c-b739-4fa1-877c-d8ff6e5166c2",
"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-16T02:24:56.4670981+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "08035ad7-8b6d-403d-8bec-998177294a9c",
"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": "183627a1-b0cd-4eec-811f-f565826b465b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-16T02:24:56.48272+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "436ed01a-0715-4819-aeb7-20f2d56b86bd"
},
"suggested_date_start": "2026-05-16T02:24:56.48272+00:00",
"skill_id": "859d2378-bccf-42fb-9565-52bf8dfdd9f4",
"skill_code": "sample string 32",
"skill": {
"id": "493528b9-02c8-4ea9-a07d-033749b08680",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2f60699d-edbe-4a74-84ec-196b4b968e5a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "39461043-64c5-454c-80ad-0d8fc13c3eff",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0338c77-9c2a-4363-ad4c-8710b051e9e5",
"db_currency_id": "e4b807d9-8154-416f-bc6f-75dfbbd5f0fe",
"db_language_id": "ff6b8d0c-b739-4fa1-877c-d8ff6e5166c2",
"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-16T02:24:56.4670981+00:00"
},
"modified_dateutc": "2026-05-16T02:24:56.48272+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "21777f97-e922-4c21-b64a-6bfa66a8997a",
"date_reported_by_company": "2026-05-16T02:24:56.48272+00:00",
"id2": 36,
"company_id": "06a3181e-0cd4-44fe-977f-54be4b960bae",
"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": "e62d86a7-71d7-4486-809a-4e217743bb01",
"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-16T02:24:56.48272+00:00"
},
"work_instruction_details_id": "33908ccb-2920-4b7a-9912-57ef428ea877",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d6161828-a7ef-48b2-b3a5-bf05cb14fe91",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "33d5a954-8902-4f6d-a10e-c8e728ef67c8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-16T02:24:56.48272+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": "ee3f6830-af65-4723-9ae2-f5ceee6ab793",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-16T02:24:56.48272+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.