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": "17053089-a8ec-4fb6-a3db-53c5bf608ec7",
"jobs_id": "1cf1bdbb-8a59-436d-9792-1575df7fa326",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3c85a004-deb2-455f-a6e3-c204baa16576",
"_parent_id": "ccc0eef7-f4e8-4f7e-bc5e-168227458eef",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "aa24708b-9b3d-4d53-b586-e5c22abaf5b2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f9e80ad2-7cb3-4314-a998-765ebe756499",
"_parent_id": "77e051e0-8fc3-4dbe-93c7-6eb7820bafe2",
"root_parent_id": "de97ffff-6073-475e-be9d-a9fd1df3a5da",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "eeaaa997-c1f6-4533-8225-e7f93c5c9997",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1e44a473-531f-4ecc-aa99-a712111c2475",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "41ea3ed0-a776-457b-8f82-555cc332cbdb",
"_parent_code": "sample string 6",
"sales_organization_id": "2cb78fbe-04bc-48c4-956e-22486709a00f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fd1b072e-459c-4f8c-a06c-dd4bc8820637",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6a3314f-d3c9-4efe-878a-467a09062c38",
"db_currency_id": "2c11cf8f-3e6a-4538-ba0c-e844136d362c",
"db_language_id": "ae6baf93-7ab3-4f94-b3fe-4dbba3b4bf26",
"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-02-16T03:15:54.7749421+00:00"
},
"modified_dateutc": "2026-02-16T03:15:54.7749421+00:00"
},
"equipment_model_id": "d3868e7d-c77b-4006-94e8-7686a574021e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "50ffe8ff-fc51-4f39-8fcd-09f940a276ca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "eeea8f6f-09ba-45d8-81ad-08c1293bf54d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "abe75644-3bee-44de-865f-11745f4def85",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6b06739e-a39d-47d9-b9fe-5acb33a654a8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fd1b072e-459c-4f8c-a06c-dd4bc8820637",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6a3314f-d3c9-4efe-878a-467a09062c38",
"db_currency_id": "2c11cf8f-3e6a-4538-ba0c-e844136d362c",
"db_language_id": "ae6baf93-7ab3-4f94-b3fe-4dbba3b4bf26",
"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-02-16T03:15:54.7749421+00:00"
},
"modified_dateutc": "2026-02-16T03:15:54.7905704+00:00"
},
"equipment_family_id": "c8233259-d9d8-4c4b-888d-3ea1596ae0d9",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1e44a473-531f-4ecc-aa99-a712111c2475",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "41ea3ed0-a776-457b-8f82-555cc332cbdb",
"_parent_code": "sample string 6",
"sales_organization_id": "2cb78fbe-04bc-48c4-956e-22486709a00f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fd1b072e-459c-4f8c-a06c-dd4bc8820637",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6a3314f-d3c9-4efe-878a-467a09062c38",
"db_currency_id": "2c11cf8f-3e6a-4538-ba0c-e844136d362c",
"db_language_id": "ae6baf93-7ab3-4f94-b3fe-4dbba3b4bf26",
"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-02-16T03:15:54.7749421+00:00"
},
"modified_dateutc": "2026-02-16T03:15:54.7749421+00:00"
},
"date_in_production_since": "2026-02-16T03:15:54.7905704+00:00",
"date_out_of_production_since": "2026-02-16T03:15:54.7905704+00:00",
"date_end_support": "2026-02-16T03:15:54.7905704+00:00",
"sales_organization_id": "3057fb07-55a8-4f84-83d3-dc00d32182b3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fd1b072e-459c-4f8c-a06c-dd4bc8820637",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6a3314f-d3c9-4efe-878a-467a09062c38",
"db_currency_id": "2c11cf8f-3e6a-4538-ba0c-e844136d362c",
"db_language_id": "ae6baf93-7ab3-4f94-b3fe-4dbba3b4bf26",
"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-02-16T03:15:54.7749421+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-02-16T03:15:54.7905704+00:00"
},
"project_status_id": "707d4608-831f-49d3-9c3d-dbf2d46620c4",
"project_status_code": "sample string 10",
"project_status": {
"id": "a4c939bc-8613-446a-ae9b-c60811370ae7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "59a26a04-418a-46bb-9305-2dade9c4c14c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fd1b072e-459c-4f8c-a06c-dd4bc8820637",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6a3314f-d3c9-4efe-878a-467a09062c38",
"db_currency_id": "2c11cf8f-3e6a-4538-ba0c-e844136d362c",
"db_language_id": "ae6baf93-7ab3-4f94-b3fe-4dbba3b4bf26",
"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-02-16T03:15:54.7749421+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-16T03:15:54.7905704+00:00"
},
"company_id": "75b633f2-ac1b-4616-929c-4ddb4b643b23",
"company_code": "sample string 12",
"db_address_id": "7f13e2f0-ff3b-4181-8461-61b2ef8e1b8f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e9b64464-cd81-45d3-bdea-4df2e164d277",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5aa13a6f-db01-44ee-bd6c-82745a8d2fcc",
"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-02-16T03:15:54.7905704+00:00",
"date_create": "2026-02-16T03:15:54.7905704+00:00",
"date_update": "2026-02-16T03:15:54.7905704+00:00",
"updated_by_user_id": "af123386-af80-4f5f-892b-b61d800bb9c7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-16T03:15:54.7905704+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-02-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-16T03:15:54.7905704+00:00",
"date_last_job": "2026-02-16T03:15:54.7905704+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-16T03:15:54.7905704+00:00",
"modified_dateutc": "2026-02-16T03:15:54.7905704+00:00",
"is_mobile_installation": true
},
"job_type_id": "82835f5b-441d-4b10-b543-1c9318f3e962",
"job_type_code": "sample string 7",
"job_type": {
"id": "bf81187b-28bb-4e77-b93a-2e48f6608504",
"name": "sample string 2",
"sales_organization_id": "3ceb38c1-ea29-41f9-9077-de30f4159dd0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-16T03:15:54.7905704+00:00",
"code": "sample string 7"
},
"job_priority_id": "64e8588a-20ba-43f2-a58c-65ddd076371d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9bf42c75-39fa-45ec-92a0-76c6e0eef838",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "94c07385-5777-462b-afdc-c7a9556b0c64",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fd1b072e-459c-4f8c-a06c-dd4bc8820637",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6a3314f-d3c9-4efe-878a-467a09062c38",
"db_currency_id": "2c11cf8f-3e6a-4538-ba0c-e844136d362c",
"db_language_id": "ae6baf93-7ab3-4f94-b3fe-4dbba3b4bf26",
"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-02-16T03:15:54.7749421+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-16T03:15:54.7905704+00:00"
},
"job_status_id": "480c7db9-e7ab-4fbb-af09-62f81717f567",
"job_status_code": "sample string 11",
"db_address_id": "625b899b-7fe3-490e-8ffb-2f9b4b1405ac",
"contact_id": "c80c7318-2b71-4954-83a8-e713e71f1410",
"requested_by_company_id": "dd67db6e-354b-4635-b327-e4625cfba57a",
"requested_by_contact_id": "0f8f00fd-2e9b-4108-b59a-b841ee239669",
"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-02-16T03:15:54.7905704+00:00",
"due_date": "2026-02-16T03:15:54.7905704+00:00",
"date_create": "2026-02-16T03:15:54.7905704+00:00",
"date_update": "2026-02-16T03:15:54.7905704+00:00",
"date_closed": "2026-02-16T03:15:54.7905704+00:00",
"suggested_user_id": "c359d9a8-6516-4d89-9673-b0ff20d6c670",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5b177563-1351-4641-9fd2-8ed96b023415",
"db_language_id": "c192edbb-dade-4c90-af4d-2879fffed743",
"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-02-16T03:15:54.7905704+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "da89ee88-9a4c-4ada-92c9-6226868cf2d3",
"sales_organization": {
"id": "fd1b072e-459c-4f8c-a06c-dd4bc8820637",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6a3314f-d3c9-4efe-878a-467a09062c38",
"db_currency_id": "2c11cf8f-3e6a-4538-ba0c-e844136d362c",
"db_language_id": "ae6baf93-7ab3-4f94-b3fe-4dbba3b4bf26",
"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-02-16T03:15:54.7749421+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "aabe2957-b2e1-418c-be16-695151650e87",
"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": "8f2911e6-3280-4d65-a8a0-f097d777fa52",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-16T03:15:54.7905704+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f78e474c-588f-43bb-b413-8e45de7b721c"
},
"suggested_date_start": "2026-02-16T03:15:54.7905704+00:00",
"skill_id": "41e84219-2924-4f2f-8744-486226883e3f",
"skill_code": "sample string 32",
"skill": {
"id": "e9251c66-34d1-486d-877f-f611c3af99c0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "17864686-1b77-4675-85e9-30c3c9861b3e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fd1b072e-459c-4f8c-a06c-dd4bc8820637",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6a3314f-d3c9-4efe-878a-467a09062c38",
"db_currency_id": "2c11cf8f-3e6a-4538-ba0c-e844136d362c",
"db_language_id": "ae6baf93-7ab3-4f94-b3fe-4dbba3b4bf26",
"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-02-16T03:15:54.7749421+00:00"
},
"modified_dateutc": "2026-02-16T03:15:54.7905704+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7a807147-3cd6-4c04-85d3-8822dca764cd",
"date_reported_by_company": "2026-02-16T03:15:54.7905704+00:00",
"id2": 36,
"company_id": "1d748bf9-f424-45db-8299-e9e3f0e4b0a5",
"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": "fbfddd44-b55f-41f2-8428-01456f0ba5eb",
"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-02-16T03:15:54.7905704+00:00"
},
"work_instruction_details_id": "28624ddb-3282-4199-8fb5-c50d00cafeb3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "abbe86f2-9b42-4e75-9f9d-0ac21b7ccbae",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8950984e-2379-4e19-8bc8-c94b2dfec9ef",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-16T03:15:54.7905704+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": "bfb4f124-a169-4e3e-961d-8ea5b4fd24a3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-16T03:15:54.7905704+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.