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": "7080cae4-57f9-444e-bb25-3035f56d7efb",
"jobs_id": "92ce8fb9-6027-4951-8672-8a3de78625ac",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8ae46924-f891-442c-be5c-b68b55e8c26b",
"_parent_id": "8c362f5b-20ca-4a7a-b1a2-f9c34d417b3e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "272a8ba7-cdd9-4a2d-bb9c-99e731ed4ad4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7d81b1c7-09e8-4e68-b026-4b9a23a7c4e8",
"_parent_id": "8871fdc9-75f1-4630-9b35-7a1d448f9ff2",
"root_parent_id": "e2816b3e-dfd4-475e-bbfa-8d932e1a79d6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a4b02f68-3c0f-4321-b723-d60a88097693",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b041e9e0-b564-4636-8c68-d80dfff0aa39",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0776ec03-cfb0-4706-902e-405c5fd7aa39",
"_parent_code": "sample string 6",
"sales_organization_id": "5e82e6b9-f72c-4c58-bd5e-6a5423fdce34",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "29b54b27-3b89-48f9-80b6-5ccd7810e928",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5674f3d5-e228-4d34-8d23-f3d920f69504",
"db_currency_id": "caf2d846-dad6-4c47-9c6b-69512c721df7",
"db_language_id": "1f82c1c2-4fca-4fe7-800f-d45f61bc8673",
"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-18T06:49:15.6081692+00:00"
},
"modified_dateutc": "2026-08-18T06:49:15.6081692+00:00"
},
"equipment_model_id": "e9f6c837-02c4-4376-b122-f3cf2ac5e7a5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "7700622f-4b21-407e-8d5d-4f6dc126c174",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "07597a07-9e64-4846-8629-88394c3b4169",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e3695dba-369e-4e06-a313-c631034ad502",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7ad9a182-53bf-4633-a04c-67ae6cd4a922",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "29b54b27-3b89-48f9-80b6-5ccd7810e928",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5674f3d5-e228-4d34-8d23-f3d920f69504",
"db_currency_id": "caf2d846-dad6-4c47-9c6b-69512c721df7",
"db_language_id": "1f82c1c2-4fca-4fe7-800f-d45f61bc8673",
"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-18T06:49:15.6081692+00:00"
},
"modified_dateutc": "2026-08-18T06:49:15.6081692+00:00"
},
"equipment_family_id": "e2f4cc9e-1390-45c7-81b5-6c85cc705f5f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b041e9e0-b564-4636-8c68-d80dfff0aa39",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0776ec03-cfb0-4706-902e-405c5fd7aa39",
"_parent_code": "sample string 6",
"sales_organization_id": "5e82e6b9-f72c-4c58-bd5e-6a5423fdce34",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "29b54b27-3b89-48f9-80b6-5ccd7810e928",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5674f3d5-e228-4d34-8d23-f3d920f69504",
"db_currency_id": "caf2d846-dad6-4c47-9c6b-69512c721df7",
"db_language_id": "1f82c1c2-4fca-4fe7-800f-d45f61bc8673",
"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-18T06:49:15.6081692+00:00"
},
"modified_dateutc": "2026-08-18T06:49:15.6081692+00:00"
},
"date_in_production_since": "2026-08-18T06:49:15.6081692+00:00",
"date_out_of_production_since": "2026-08-18T06:49:15.6081692+00:00",
"date_end_support": "2026-08-18T06:49:15.6081692+00:00",
"sales_organization_id": "4a2417f7-63cf-4258-8541-6053007a8faf",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "29b54b27-3b89-48f9-80b6-5ccd7810e928",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5674f3d5-e228-4d34-8d23-f3d920f69504",
"db_currency_id": "caf2d846-dad6-4c47-9c6b-69512c721df7",
"db_language_id": "1f82c1c2-4fca-4fe7-800f-d45f61bc8673",
"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-18T06:49:15.6081692+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-18T06:49:15.6081692+00:00"
},
"project_status_id": "0c716425-fc9a-45bc-ae31-af5e1c15a26a",
"project_status_code": "sample string 10",
"project_status": {
"id": "a81ce4e0-d07d-4c80-8db5-9b5ccf95e812",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "04b60a74-ae2f-4e63-aceb-b92d47201490",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "29b54b27-3b89-48f9-80b6-5ccd7810e928",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5674f3d5-e228-4d34-8d23-f3d920f69504",
"db_currency_id": "caf2d846-dad6-4c47-9c6b-69512c721df7",
"db_language_id": "1f82c1c2-4fca-4fe7-800f-d45f61bc8673",
"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-18T06:49:15.6081692+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-18T06:49:15.6081692+00:00"
},
"company_id": "539e2349-632f-4cb9-b920-79de45624b14",
"company_code": "sample string 12",
"db_address_id": "48941db1-e065-4181-9ae1-742fa6f9ed3b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9742c36b-5a13-4f26-8175-ad67366c8c4f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "507f202b-e180-41cc-b8a2-d6ef7b67d3d1",
"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-18T06:49:15.6081692+00:00",
"date_create": "2026-08-18T06:49:15.6081692+00:00",
"date_update": "2026-08-18T06:49:15.6081692+00:00",
"updated_by_user_id": "ea755565-4dc9-4a77-b74b-c609fa773878",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-18T06:49:15.6081692+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-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-18T06:49:15.6081692+00:00",
"date_last_job": "2026-08-18T06:49:15.6081692+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-18T06:49:15.6081692+00:00",
"modified_dateutc": "2026-08-18T06:49:15.6081692+00:00",
"is_mobile_installation": true
},
"job_type_id": "1448b898-f4c3-49ba-85af-ea89101a0b05",
"job_type_code": "sample string 7",
"job_type": {
"id": "b52c25a9-e156-46db-8b54-479517deab81",
"name": "sample string 2",
"sales_organization_id": "553e7085-7564-48b8-9bb0-f0cbacb758f0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-18T06:49:15.6081692+00:00",
"code": "sample string 7"
},
"job_priority_id": "4d0189ba-4e7a-4702-800f-35a51d7eb0b0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "aa780f75-52a6-4631-8228-bca618136647",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0876f9ed-190a-4c8d-af44-c0a8b83f45b5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "29b54b27-3b89-48f9-80b6-5ccd7810e928",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5674f3d5-e228-4d34-8d23-f3d920f69504",
"db_currency_id": "caf2d846-dad6-4c47-9c6b-69512c721df7",
"db_language_id": "1f82c1c2-4fca-4fe7-800f-d45f61bc8673",
"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-18T06:49:15.6081692+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-18T06:49:15.6081692+00:00"
},
"job_status_id": "cb574c6e-c9c9-42be-bef4-c56da34decec",
"job_status_code": "sample string 11",
"db_address_id": "72f01ade-a3f9-49fa-92c4-60762cdcc362",
"contact_id": "ade6d4fe-f1b8-4c09-9ae3-f10d2d689ee9",
"requested_by_company_id": "7326a503-89af-47cc-9d78-6b1a9eca764c",
"requested_by_contact_id": "2a53ffd1-3c65-48f7-b0ad-9bac8d0461ad",
"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-18T06:49:15.6081692+00:00",
"due_date": "2026-08-18T06:49:15.6081692+00:00",
"date_create": "2026-08-18T06:49:15.6081692+00:00",
"date_update": "2026-08-18T06:49:15.6081692+00:00",
"date_closed": "2026-08-18T06:49:15.6081692+00:00",
"suggested_user_id": "4d6a8e73-3f65-462f-863d-0cecac307848",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "24a8cf57-5721-474f-9ffd-621d1c435a83",
"db_language_id": "050e473a-8472-4544-aea0-25f1fefa1251",
"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-18T06:49:15.6081692+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c21b4a96-0948-49aa-90e2-d4fcdcbda81e",
"sales_organization": {
"id": "29b54b27-3b89-48f9-80b6-5ccd7810e928",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5674f3d5-e228-4d34-8d23-f3d920f69504",
"db_currency_id": "caf2d846-dad6-4c47-9c6b-69512c721df7",
"db_language_id": "1f82c1c2-4fca-4fe7-800f-d45f61bc8673",
"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-18T06:49:15.6081692+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e2cfcb93-5452-4792-bb7d-46442f0b032a",
"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": "19fd29d3-f697-47ff-b51e-fdece6e52ebf",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-18T06:49:15.6081692+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1c184373-7545-4e59-8718-b00a72a86249"
},
"suggested_date_start": "2026-08-18T06:49:15.6081692+00:00",
"skill_id": "4626f9b7-86f4-4c16-b567-82be79a072e9",
"skill_code": "sample string 32",
"skill": {
"id": "b86bc922-8852-4b36-999d-d1c69c5f795f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7589bdf0-45f3-4eed-b68c-17089ca62e23",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "29b54b27-3b89-48f9-80b6-5ccd7810e928",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5674f3d5-e228-4d34-8d23-f3d920f69504",
"db_currency_id": "caf2d846-dad6-4c47-9c6b-69512c721df7",
"db_language_id": "1f82c1c2-4fca-4fe7-800f-d45f61bc8673",
"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-18T06:49:15.6081692+00:00"
},
"modified_dateutc": "2026-08-18T06:49:15.6081692+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0c8e98b8-421f-4649-8cdb-7ac77166d174",
"date_reported_by_company": "2026-08-18T06:49:15.6081692+00:00",
"id2": 36,
"company_id": "0f1b9fe6-7dec-4b6f-993d-c32ab00715f8",
"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": "3ab6b1d7-61b7-4235-9682-7619735ee260",
"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-18T06:49:15.6081692+00:00"
},
"work_instruction_details_id": "557cb086-3ddd-4f2b-86be-9eaf5e4a6619",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "506d8cb9-e4d7-44aa-b4eb-6a313e47c06d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "27550769-a3ab-4094-9355-f01f887e4dda",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-18T06:49:15.6081692+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": "ab4fd6b0-bc9f-4899-80e6-4f472fa2e356",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-18T06:49:15.6081692+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.