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": "c8764cac-cb65-4435-b808-f167c37cd8fb",
"jobs_id": "a1e1352a-2e47-4e51-9bb6-28b3dfa69c07",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "142c92b3-44ab-4eea-81c8-b53f86ab174c",
"_parent_id": "1eb1d1cd-bc56-4494-a3bc-2da1e96e0d65",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a3b58200-0371-4f73-bb01-fafb3ce9dc6d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e87eeb5a-4c0e-4f53-b33e-3e4a485cd11c",
"_parent_id": "0ba91afd-28ae-4a5e-aeee-5f27fc02547f",
"root_parent_id": "1f589e34-17f9-4886-93af-ae0061193fe7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7eb30b64-8ce0-40a0-8f9d-f3274c64a7f1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "074b2051-6ab8-42f0-a911-81f5a9a61539",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "463b2393-349d-4e3e-880e-524f4e6590d5",
"_parent_code": "sample string 6",
"sales_organization_id": "b8e2771e-58e6-4b89-97c4-efce9f3dc02f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "00f58534-6823-419f-b481-b8c41bb91081",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "075e971c-4873-4f36-8e4e-24cfbf33b3d9",
"db_currency_id": "f4fde9a8-9c2d-4109-a13b-bf5a9a486f1f",
"db_language_id": "2d01ac3e-2014-44ef-993b-46f31b6cc407",
"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-06-26T04:53:44.3898105+00:00"
},
"modified_dateutc": "2026-06-26T04:53:44.3898105+00:00"
},
"equipment_model_id": "df7472fb-eba8-47df-9bf7-8bf9f8a6a592",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "366cc497-b0f1-41bb-a197-deffd4d8c800",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4c08817b-3fe1-4af1-84c7-3dc59e239d4e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1f960ef5-e63a-4503-9a61-33907cca9caa",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4710a142-e598-4ab7-92a0-e359674cbc2c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "00f58534-6823-419f-b481-b8c41bb91081",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "075e971c-4873-4f36-8e4e-24cfbf33b3d9",
"db_currency_id": "f4fde9a8-9c2d-4109-a13b-bf5a9a486f1f",
"db_language_id": "2d01ac3e-2014-44ef-993b-46f31b6cc407",
"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-06-26T04:53:44.3898105+00:00"
},
"modified_dateutc": "2026-06-26T04:53:44.3898105+00:00"
},
"equipment_family_id": "d40a9106-5085-46d6-8111-7a4eb4e4a6b1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "074b2051-6ab8-42f0-a911-81f5a9a61539",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "463b2393-349d-4e3e-880e-524f4e6590d5",
"_parent_code": "sample string 6",
"sales_organization_id": "b8e2771e-58e6-4b89-97c4-efce9f3dc02f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "00f58534-6823-419f-b481-b8c41bb91081",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "075e971c-4873-4f36-8e4e-24cfbf33b3d9",
"db_currency_id": "f4fde9a8-9c2d-4109-a13b-bf5a9a486f1f",
"db_language_id": "2d01ac3e-2014-44ef-993b-46f31b6cc407",
"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-06-26T04:53:44.3898105+00:00"
},
"modified_dateutc": "2026-06-26T04:53:44.3898105+00:00"
},
"date_in_production_since": "2026-06-26T04:53:44.3898105+00:00",
"date_out_of_production_since": "2026-06-26T04:53:44.3898105+00:00",
"date_end_support": "2026-06-26T04:53:44.3898105+00:00",
"sales_organization_id": "7075464f-d384-4e67-95f4-2b37f335bd41",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "00f58534-6823-419f-b481-b8c41bb91081",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "075e971c-4873-4f36-8e4e-24cfbf33b3d9",
"db_currency_id": "f4fde9a8-9c2d-4109-a13b-bf5a9a486f1f",
"db_language_id": "2d01ac3e-2014-44ef-993b-46f31b6cc407",
"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-06-26T04:53:44.3898105+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-06-26T04:53:44.3898105+00:00"
},
"project_status_id": "8384533d-756c-4b1e-b315-10b998ba6752",
"project_status_code": "sample string 10",
"project_status": {
"id": "f86607db-94f1-4ee9-b6c6-0c95037fbd26",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "45eb40c3-8954-4836-b41c-1dda112f7157",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "00f58534-6823-419f-b481-b8c41bb91081",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "075e971c-4873-4f36-8e4e-24cfbf33b3d9",
"db_currency_id": "f4fde9a8-9c2d-4109-a13b-bf5a9a486f1f",
"db_language_id": "2d01ac3e-2014-44ef-993b-46f31b6cc407",
"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-06-26T04:53:44.3898105+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-26T04:53:44.3898105+00:00"
},
"company_id": "ed89ce4f-e7ad-4194-8d21-6d6dfbf3e745",
"company_code": "sample string 12",
"db_address_id": "92377fbf-b933-4ae0-bbc2-dd83d869bca8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "145d707f-9c7f-40f4-9721-8f13ce9c3252",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e4b64456-fb50-45ff-91bb-009a8671c572",
"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-06-26T04:53:44.3898105+00:00",
"date_create": "2026-06-26T04:53:44.3898105+00:00",
"date_update": "2026-06-26T04:53:44.3898105+00:00",
"updated_by_user_id": "0d08796f-52ab-4769-b77b-83d2f305d873",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-26T04:53:44.3898105+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-06-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-26T04:53:44.3898105+00:00",
"date_last_job": "2026-06-26T04:53:44.3898105+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-26T04:53:44.3898105+00:00",
"modified_dateutc": "2026-06-26T04:53:44.3898105+00:00",
"is_mobile_installation": true
},
"job_type_id": "d4fbcd82-7426-45b9-bbda-d679f76a0dd7",
"job_type_code": "sample string 7",
"job_type": {
"id": "bef514ee-dcd8-4c0a-81d5-0f267231d4f3",
"name": "sample string 2",
"sales_organization_id": "25a008de-d1a2-4898-b213-81ac50ae39d5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-26T04:53:44.3898105+00:00",
"code": "sample string 7"
},
"job_priority_id": "64e5f86d-04cf-4645-8903-bc9600202909",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e5a73da9-ab92-4e42-8641-5b5896ad690c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2d7a5aa0-6ccf-4dad-ba98-7ddcc473df54",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "00f58534-6823-419f-b481-b8c41bb91081",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "075e971c-4873-4f36-8e4e-24cfbf33b3d9",
"db_currency_id": "f4fde9a8-9c2d-4109-a13b-bf5a9a486f1f",
"db_language_id": "2d01ac3e-2014-44ef-993b-46f31b6cc407",
"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-06-26T04:53:44.3898105+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-26T04:53:44.3898105+00:00"
},
"job_status_id": "d4e0d936-39e0-4a1c-8ba8-5f7099013944",
"job_status_code": "sample string 11",
"db_address_id": "b11f402b-fc49-4b27-885f-d43c89ed682c",
"contact_id": "4a1fee5d-c97a-4086-a1dc-23ffa9e7fa8a",
"requested_by_company_id": "ba895254-3a01-404f-8513-44621a3aaf4d",
"requested_by_contact_id": "5d9e4cc2-e2e5-4340-acfe-0c29bcf94161",
"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-06-26T04:53:44.3898105+00:00",
"due_date": "2026-06-26T04:53:44.3898105+00:00",
"date_create": "2026-06-26T04:53:44.3898105+00:00",
"date_update": "2026-06-26T04:53:44.3898105+00:00",
"date_closed": "2026-06-26T04:53:44.3898105+00:00",
"suggested_user_id": "2a4e5652-205a-4b60-94ab-be8e1829ca57",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "04c947fe-2564-40a8-83e5-02a7567869a8",
"db_language_id": "eea23827-f64e-417c-bb0b-21a834791919",
"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-06-26T04:53:44.3898105+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dd141bc9-c548-4f8a-a18c-100c774cfc87",
"sales_organization": {
"id": "00f58534-6823-419f-b481-b8c41bb91081",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "075e971c-4873-4f36-8e4e-24cfbf33b3d9",
"db_currency_id": "f4fde9a8-9c2d-4109-a13b-bf5a9a486f1f",
"db_language_id": "2d01ac3e-2014-44ef-993b-46f31b6cc407",
"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-06-26T04:53:44.3898105+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6d909774-802e-49f8-91ee-167c3eb52ac7",
"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": "7c40624d-8ba3-42c8-a084-d51441edf9f5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-26T04:53:44.3898105+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f55ef31d-61ff-4834-b84d-dd0409b37df1"
},
"suggested_date_start": "2026-06-26T04:53:44.3898105+00:00",
"skill_id": "03817628-4e8a-4c20-9086-de6a79062f53",
"skill_code": "sample string 32",
"skill": {
"id": "ad07f7bf-5222-4dd0-bf9f-959cf2128337",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "55e31c7f-418c-4783-bb16-6dc7a93745a4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "00f58534-6823-419f-b481-b8c41bb91081",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "075e971c-4873-4f36-8e4e-24cfbf33b3d9",
"db_currency_id": "f4fde9a8-9c2d-4109-a13b-bf5a9a486f1f",
"db_language_id": "2d01ac3e-2014-44ef-993b-46f31b6cc407",
"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-06-26T04:53:44.3898105+00:00"
},
"modified_dateutc": "2026-06-26T04:53:44.3898105+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "fd7276c9-f1e3-41be-ace5-51188abb022d",
"date_reported_by_company": "2026-06-26T04:53:44.3898105+00:00",
"id2": 36,
"company_id": "a65b64ca-fe06-46f3-9827-969b8662ee4c",
"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": "5fe30ff8-d296-4ba8-85e1-0760b291d0ef",
"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-06-26T04:53:44.3898105+00:00"
},
"work_instruction_details_id": "9ae2be11-6a90-448d-a92f-caf04aa9651d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "600549ba-f949-4b18-a9f2-1f9486ff3bec",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ae93c688-c112-487e-b626-5dc62520990c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-26T04:53:44.3898105+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": "981de0ca-799d-4c7f-809b-46e9804f8b68",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-26T04:53:44.3898105+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.