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": "4f7ca009-5352-4b70-b698-b5c29b5c6954",
"jobs_id": "74e35aa0-df33-4d9a-9825-bf8757e72e10",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6f2d37a2-c80c-40a4-9269-cf2c5a79acfb",
"_parent_id": "746369de-655b-4066-9c58-b2dc94149e0f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a0d3d288-59a5-4e2f-807e-a3c8f9c21574",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9719df15-2876-44eb-bd6c-59ff15ff9b29",
"_parent_id": "e90e7f9a-4e15-4ff1-b3fe-ec17cd68eea2",
"root_parent_id": "3a9cb806-df5a-4ff3-9525-bdc27aa7a064",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8f92fc8d-31f6-42e9-a16f-5b2d3cca4798",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c9f61c3b-f9dc-457c-9915-52281e54ec7a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "92383ec7-9410-4958-86c7-ea989cd6fc47",
"_parent_code": "sample string 6",
"sales_organization_id": "128de385-1792-4d08-82ce-62b2e3dfd813",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "48fd551d-66ed-4c1c-b8f5-0ee1d23cf0a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e25ad38a-1629-49ef-905f-906a197ad42b",
"db_currency_id": "9e8de73a-823f-4a42-a8bc-e073838cf2a0",
"db_language_id": "ba691bd4-0adf-47b7-b364-d0a4fcbbdf5e",
"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-08-14T07:35:59.1672918+00:00"
},
"modified_dateutc": "2026-08-14T07:35:59.1672918+00:00"
},
"equipment_model_id": "ae9d7064-43f4-4a7d-a47a-dbfa9017c8a4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e08f67c9-3b30-4677-ace0-309320c41983",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a0b5d967-550c-4d53-a186-50f211e4eae8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "eaa3ec7f-2b42-4dce-a589-242d013218cc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e99ef180-b8e2-42f3-9dcf-93d8ca629699",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "48fd551d-66ed-4c1c-b8f5-0ee1d23cf0a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e25ad38a-1629-49ef-905f-906a197ad42b",
"db_currency_id": "9e8de73a-823f-4a42-a8bc-e073838cf2a0",
"db_language_id": "ba691bd4-0adf-47b7-b364-d0a4fcbbdf5e",
"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-08-14T07:35:59.1672918+00:00"
},
"modified_dateutc": "2026-08-14T07:35:59.1672918+00:00"
},
"equipment_family_id": "4964fa17-883f-40e5-8871-573a0e09a556",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c9f61c3b-f9dc-457c-9915-52281e54ec7a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "92383ec7-9410-4958-86c7-ea989cd6fc47",
"_parent_code": "sample string 6",
"sales_organization_id": "128de385-1792-4d08-82ce-62b2e3dfd813",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "48fd551d-66ed-4c1c-b8f5-0ee1d23cf0a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e25ad38a-1629-49ef-905f-906a197ad42b",
"db_currency_id": "9e8de73a-823f-4a42-a8bc-e073838cf2a0",
"db_language_id": "ba691bd4-0adf-47b7-b364-d0a4fcbbdf5e",
"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-08-14T07:35:59.1672918+00:00"
},
"modified_dateutc": "2026-08-14T07:35:59.1672918+00:00"
},
"date_in_production_since": "2026-08-14T07:35:59.1672918+00:00",
"date_out_of_production_since": "2026-08-14T07:35:59.1672918+00:00",
"date_end_support": "2026-08-14T07:35:59.1672918+00:00",
"sales_organization_id": "449a426e-2437-4ed1-a1ad-cffea54e1fbb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "48fd551d-66ed-4c1c-b8f5-0ee1d23cf0a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e25ad38a-1629-49ef-905f-906a197ad42b",
"db_currency_id": "9e8de73a-823f-4a42-a8bc-e073838cf2a0",
"db_language_id": "ba691bd4-0adf-47b7-b364-d0a4fcbbdf5e",
"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-08-14T07:35:59.1672918+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-08-14T07:35:59.1672918+00:00"
},
"project_status_id": "b812bb3c-36ce-481e-9340-f412a064abdb",
"project_status_code": "sample string 10",
"project_status": {
"id": "46673b68-77a7-439c-9b00-ac63c0dbde25",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a44cc394-4f92-4312-a00b-39c932aa4b4a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "48fd551d-66ed-4c1c-b8f5-0ee1d23cf0a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e25ad38a-1629-49ef-905f-906a197ad42b",
"db_currency_id": "9e8de73a-823f-4a42-a8bc-e073838cf2a0",
"db_language_id": "ba691bd4-0adf-47b7-b364-d0a4fcbbdf5e",
"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-08-14T07:35:59.1672918+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-14T07:35:59.1672918+00:00"
},
"company_id": "f0fe101e-939e-4c62-b487-17c29eaad349",
"company_code": "sample string 12",
"db_address_id": "caab09c6-8deb-4903-9bc0-9776af6b5f5d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f40e8096-93cb-4294-8770-1cf1164d42bf",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c80893e0-13b9-4ef3-b55f-4fd597f1663d",
"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-08-14T07:35:59.1672918+00:00",
"date_create": "2026-08-14T07:35:59.1672918+00:00",
"date_update": "2026-08-14T07:35:59.1672918+00:00",
"updated_by_user_id": "397ad411-03ab-4aa5-9e69-d6ac80a60f41",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-14T07:35:59.1672918+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-08-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-14T07:35:59.1672918+00:00",
"date_last_job": "2026-08-14T07:35:59.1672918+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-14T07:35:59.1672918+00:00",
"modified_dateutc": "2026-08-14T07:35:59.1672918+00:00",
"is_mobile_installation": true
},
"job_type_id": "dae600ab-ef7b-4032-ad8c-14353cfeefff",
"job_type_code": "sample string 7",
"job_type": {
"id": "a2bc7def-98fe-4f60-8aa8-1650d51c9870",
"name": "sample string 2",
"sales_organization_id": "23a099a6-a4e0-419a-9641-851100bc1aec",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-14T07:35:59.1672918+00:00",
"code": "sample string 7"
},
"job_priority_id": "31eb9174-d15c-4089-90a7-b0210c56a0b0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b84350c1-f18d-4c35-95b8-0f688d3158d4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "535b066e-6409-421a-ab8d-742088004fab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "48fd551d-66ed-4c1c-b8f5-0ee1d23cf0a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e25ad38a-1629-49ef-905f-906a197ad42b",
"db_currency_id": "9e8de73a-823f-4a42-a8bc-e073838cf2a0",
"db_language_id": "ba691bd4-0adf-47b7-b364-d0a4fcbbdf5e",
"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-08-14T07:35:59.1672918+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-14T07:35:59.1672918+00:00"
},
"job_status_id": "02148cb5-8246-4023-80e8-d70b4bb569cb",
"job_status_code": "sample string 11",
"db_address_id": "d1d08bf1-2731-4f6e-b69c-c1f3cb10d544",
"contact_id": "c4598575-bd3e-416e-9989-04550e2099b3",
"requested_by_company_id": "2dafc5ca-bd45-4a6e-a670-2e883960ff2b",
"requested_by_contact_id": "3bf21f6d-b673-4bcc-b05c-090333ce5ef7",
"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-08-14T07:35:59.1672918+00:00",
"due_date": "2026-08-14T07:35:59.1672918+00:00",
"date_create": "2026-08-14T07:35:59.1672918+00:00",
"date_update": "2026-08-14T07:35:59.1672918+00:00",
"date_closed": "2026-08-14T07:35:59.1672918+00:00",
"suggested_user_id": "dbeca891-0420-48ea-afa1-7265d6a1ce3f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7d479f2a-fb7c-4116-82f1-77c1122501d9",
"db_language_id": "bc93a8a8-6737-4ab8-8e3f-b8bde43c1558",
"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-08-14T07:35:59.1672918+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2ca1d73b-41e2-454c-a5c6-c278a430a118",
"sales_organization": {
"id": "48fd551d-66ed-4c1c-b8f5-0ee1d23cf0a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e25ad38a-1629-49ef-905f-906a197ad42b",
"db_currency_id": "9e8de73a-823f-4a42-a8bc-e073838cf2a0",
"db_language_id": "ba691bd4-0adf-47b7-b364-d0a4fcbbdf5e",
"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-08-14T07:35:59.1672918+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8f4476dd-95b6-45e1-9f4f-0ba6ace14924",
"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": "693a88a5-a6b9-4dcd-b126-b2a2ab21a0ba",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-14T07:35:59.1672918+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0b62db12-b5fe-4895-bfa2-3f67110a3b5c"
},
"suggested_date_start": "2026-08-14T07:35:59.1672918+00:00",
"skill_id": "c01e7b26-ff51-4b3c-8539-6bc68871b170",
"skill_code": "sample string 32",
"skill": {
"id": "75f77de9-3749-4288-8ff4-5809003660ec",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "33c4a62b-83ec-478f-b836-17ede4e8296e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "48fd551d-66ed-4c1c-b8f5-0ee1d23cf0a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e25ad38a-1629-49ef-905f-906a197ad42b",
"db_currency_id": "9e8de73a-823f-4a42-a8bc-e073838cf2a0",
"db_language_id": "ba691bd4-0adf-47b7-b364-d0a4fcbbdf5e",
"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-08-14T07:35:59.1672918+00:00"
},
"modified_dateutc": "2026-08-14T07:35:59.1672918+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "493ea342-a0ba-470c-9c0a-5bec33efbac2",
"date_reported_by_company": "2026-08-14T07:35:59.1672918+00:00",
"id2": 36,
"company_id": "9e7fa50f-9013-4082-bcc2-ec1792b2d791",
"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": "88281177-70fc-4503-8d3b-e99a46a8528a",
"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-08-14T07:35:59.1672918+00:00"
},
"work_instruction_details_id": "4efa9a1a-6113-480a-a0a7-4eef4d42e926",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "982750eb-4cbc-4f02-8fa6-78bbfe1a2f9f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "98bf57f3-e0e5-4178-9804-cf89b6c942b9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-14T07:35:59.1672918+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": "08b2ff1e-1855-4317-a352-6c92fbc77b80",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-14T07:35:59.1672918+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.