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": "48af6be0-4ce3-4d0e-a744-a8ad3fd9c9dc",
"jobs_id": "5adbc389-39bf-4b40-a65e-8d71692ba3d3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e136b1d0-f1c4-4802-8c82-ddd3ff5af992",
"_parent_id": "d78b631a-c009-4218-bdf4-f2a607f197f4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fe5cc77f-2043-4dde-8562-93004591d151",
"project_reference_back_office": "sample string 5",
"project": {
"id": "caa7c525-d194-44d2-906c-2f7e34f730af",
"_parent_id": "8682ee36-36cd-4708-8a56-70252cf9a1c8",
"root_parent_id": "e258aded-c832-44b9-b544-d95a4195b709",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2049f1c5-cce6-4e30-aff7-73cc222e92e4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "59656936-dd72-4e7c-a5c5-4ae4b5e5d117",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "007c553e-f996-44df-a50b-aeced4e1a471",
"_parent_code": "sample string 6",
"sales_organization_id": "704c2cbf-59a2-42ee-9e32-2819d8e5a389",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f1a1ed3a-5ba8-49c5-9c3d-da3cfe2bb5e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d7e7508-ff85-4262-a028-52289f15d0a8",
"db_currency_id": "62f6811f-4757-4152-b67b-9b64ab9437cc",
"db_language_id": "2581dce6-9c05-4616-b7c9-8e13925ee8b3",
"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": "2025-11-11T02:01:16.8255284+00:00"
},
"modified_dateutc": "2025-11-11T02:01:16.8255284+00:00"
},
"equipment_model_id": "3fbb62d8-fc81-4039-b86c-ed64ff9cecbf",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f2ded21e-32f2-4e37-9270-974097aec26c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f06c3a4b-3a15-4e4c-b1d1-cee0d4fc0ad3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2b0a50ea-05fb-4c91-8d5b-e236df7f2142",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "de73addf-7076-4232-9421-84a0d57a77b7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f1a1ed3a-5ba8-49c5-9c3d-da3cfe2bb5e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d7e7508-ff85-4262-a028-52289f15d0a8",
"db_currency_id": "62f6811f-4757-4152-b67b-9b64ab9437cc",
"db_language_id": "2581dce6-9c05-4616-b7c9-8e13925ee8b3",
"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": "2025-11-11T02:01:16.8255284+00:00"
},
"modified_dateutc": "2025-11-11T02:01:16.8255284+00:00"
},
"equipment_family_id": "bd8ae045-a2a0-4311-8457-44e139644dee",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "59656936-dd72-4e7c-a5c5-4ae4b5e5d117",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "007c553e-f996-44df-a50b-aeced4e1a471",
"_parent_code": "sample string 6",
"sales_organization_id": "704c2cbf-59a2-42ee-9e32-2819d8e5a389",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f1a1ed3a-5ba8-49c5-9c3d-da3cfe2bb5e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d7e7508-ff85-4262-a028-52289f15d0a8",
"db_currency_id": "62f6811f-4757-4152-b67b-9b64ab9437cc",
"db_language_id": "2581dce6-9c05-4616-b7c9-8e13925ee8b3",
"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": "2025-11-11T02:01:16.8255284+00:00"
},
"modified_dateutc": "2025-11-11T02:01:16.8255284+00:00"
},
"date_in_production_since": "2025-11-11T02:01:16.8255284+00:00",
"date_out_of_production_since": "2025-11-11T02:01:16.8255284+00:00",
"date_end_support": "2025-11-11T02:01:16.8255284+00:00",
"sales_organization_id": "18e4ebb2-6c2a-4f26-bb32-5e94c74b6f68",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f1a1ed3a-5ba8-49c5-9c3d-da3cfe2bb5e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d7e7508-ff85-4262-a028-52289f15d0a8",
"db_currency_id": "62f6811f-4757-4152-b67b-9b64ab9437cc",
"db_language_id": "2581dce6-9c05-4616-b7c9-8e13925ee8b3",
"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": "2025-11-11T02:01:16.8255284+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": "2025-11-11T02:01:16.8255284+00:00"
},
"project_status_id": "1ff95d62-afba-429f-b1fc-f4d4c43e7964",
"project_status_code": "sample string 10",
"project_status": {
"id": "7cd136d4-afbe-44bb-a780-f9e021811faf",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7c808993-43d1-402a-a4d1-45e21649c8cb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f1a1ed3a-5ba8-49c5-9c3d-da3cfe2bb5e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d7e7508-ff85-4262-a028-52289f15d0a8",
"db_currency_id": "62f6811f-4757-4152-b67b-9b64ab9437cc",
"db_language_id": "2581dce6-9c05-4616-b7c9-8e13925ee8b3",
"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": "2025-11-11T02:01:16.8255284+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-11T02:01:16.8255284+00:00"
},
"company_id": "ab5a2335-c90b-44ff-a804-d245675d4ac4",
"company_code": "sample string 12",
"db_address_id": "d7fc5afa-58ac-4396-9766-5ae501599882",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2bb5b2cf-b915-4344-9622-359418153896",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d4740df1-1acb-4a9b-abb9-58e41679576c",
"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": "2025-11-11T02:01:16.8255284+00:00",
"date_create": "2025-11-11T02:01:16.8255284+00:00",
"date_update": "2025-11-11T02:01:16.8255284+00:00",
"updated_by_user_id": "3f13e83a-e159-4217-8749-cc39d61c6793",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-11T02:01:16.8255284+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": "2025-11-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-11T02:01:16.8255284+00:00",
"date_last_job": "2025-11-11T02:01:16.8255284+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-11T02:01:16.8255284+00:00",
"modified_dateutc": "2025-11-11T02:01:16.8255284+00:00",
"is_mobile_installation": true
},
"job_type_id": "7831bd67-e42b-447f-ae54-78cbd1a0d598",
"job_type_code": "sample string 7",
"job_type": {
"id": "773c40a4-f27f-47f5-91fb-f4e5e3ba88b1",
"name": "sample string 2",
"sales_organization_id": "e535339f-c70b-4112-afb3-493b6ae126b3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-11T02:01:16.8255284+00:00",
"code": "sample string 7"
},
"job_priority_id": "a77c02f3-48f4-448d-802e-f13fcd6fb94d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5a83ad7e-5314-4164-bcd2-5b6159b9783c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "372bb794-f132-43a2-9cff-afbfd792ff5b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f1a1ed3a-5ba8-49c5-9c3d-da3cfe2bb5e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d7e7508-ff85-4262-a028-52289f15d0a8",
"db_currency_id": "62f6811f-4757-4152-b67b-9b64ab9437cc",
"db_language_id": "2581dce6-9c05-4616-b7c9-8e13925ee8b3",
"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": "2025-11-11T02:01:16.8255284+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-11T02:01:16.8255284+00:00"
},
"job_status_id": "6f3f6db1-e382-49da-b8d4-61ad49817290",
"job_status_code": "sample string 11",
"db_address_id": "a4df854b-f553-4110-831b-e44a1a4072ac",
"contact_id": "076728a8-952d-471f-bc19-13bba7de137d",
"requested_by_company_id": "b4474c85-491f-4ae6-bc81-8f35c844f039",
"requested_by_contact_id": "cc323a90-a66c-4db6-94f5-46c5268a8e64",
"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": "2025-11-11T02:01:16.8255284+00:00",
"due_date": "2025-11-11T02:01:16.8255284+00:00",
"date_create": "2025-11-11T02:01:16.8255284+00:00",
"date_update": "2025-11-11T02:01:16.8255284+00:00",
"date_closed": "2025-11-11T02:01:16.8255284+00:00",
"suggested_user_id": "5279b39d-4add-4ddb-b989-56414852e2c7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "61739e4a-bc36-4e3c-bee0-761d8fb46462",
"db_language_id": "afc38b26-3e32-45e0-8816-6b117159b47a",
"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": "2025-11-11T02:01:16.8255284+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "24664bca-3f52-459c-86e0-ea9d8ea44afd",
"sales_organization": {
"id": "f1a1ed3a-5ba8-49c5-9c3d-da3cfe2bb5e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d7e7508-ff85-4262-a028-52289f15d0a8",
"db_currency_id": "62f6811f-4757-4152-b67b-9b64ab9437cc",
"db_language_id": "2581dce6-9c05-4616-b7c9-8e13925ee8b3",
"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": "2025-11-11T02:01:16.8255284+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d2f346d9-748c-426f-a56e-84dc30935908",
"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": "8a8ae362-edd2-4139-82c0-b59518b53965",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-11T02:01:16.8255284+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "76fb753b-dc9d-4db2-b3fb-787c127bfb1b"
},
"suggested_date_start": "2025-11-11T02:01:16.8255284+00:00",
"skill_id": "9a38bb93-80cd-47c1-81dd-7e52a08dc8a0",
"skill_code": "sample string 32",
"skill": {
"id": "85d35515-05b1-469d-8d54-550dda138571",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5da6b55a-f377-49b2-add6-ec4002b0f24a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f1a1ed3a-5ba8-49c5-9c3d-da3cfe2bb5e9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1d7e7508-ff85-4262-a028-52289f15d0a8",
"db_currency_id": "62f6811f-4757-4152-b67b-9b64ab9437cc",
"db_language_id": "2581dce6-9c05-4616-b7c9-8e13925ee8b3",
"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": "2025-11-11T02:01:16.8255284+00:00"
},
"modified_dateutc": "2025-11-11T02:01:16.8255284+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "18a3fcef-1f97-47b3-bffc-8aa81dc89b42",
"date_reported_by_company": "2025-11-11T02:01:16.8255284+00:00",
"id2": 36,
"company_id": "61b5c120-636b-466f-8ee2-f5bf773af8f2",
"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": "0f76cfeb-a3c7-4717-bcdf-f27ba7e6fcd3",
"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": "2025-11-11T02:01:16.8255284+00:00"
},
"work_instruction_details_id": "07370b6b-e762-4fcf-8892-96465b31f587",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b53ea899-9f20-47e8-bbae-ce7983230302",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "331e3fff-4814-48b1-ad80-ac4dfc1c9fc2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-11T02:01:16.8255284+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": "2740dec2-49b4-4e45-a959-eb2cac32b272",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-11T02:01:16.8255284+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.