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": "ac613396-2501-468d-b94a-f4dd92d75504",
"jobs_id": "d76d1b65-5ba1-40cb-94c3-9653a2765ea9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "cb970b4a-41ab-490d-ad3f-f3c078e818bd",
"_parent_id": "d0a9c5da-531b-49f6-b296-dd0a23a0d265",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "12ec885f-175f-45a0-9bfe-43dcefcf89be",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7d1c0fed-c5f7-40b2-844c-a28936eaf326",
"_parent_id": "579e264a-e79c-42ac-859f-1e93ac81a0aa",
"root_parent_id": "b6d88aa1-6ea7-474d-8bd3-6b63194028fc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "072effac-851d-4439-9313-754be67fc464",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3be964cc-a9a6-408b-86fa-eb810df7271c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3edfd03d-e54d-4837-8048-856a082e9ccd",
"_parent_code": "sample string 6",
"sales_organization_id": "422381f0-f687-4342-8289-377c06e869bf",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7367baf0-7e64-48df-9a15-5f574929fa85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2f0322a7-7463-4d20-8042-4b487b942302",
"db_currency_id": "14c8986c-19a2-4354-8261-aa6e51dac39e",
"db_language_id": "f34a204d-e16b-4438-9387-f24ad67be62e",
"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-09-17T07:14:20.3246011+00:00"
},
"modified_dateutc": "2026-09-17T07:14:20.3246011+00:00"
},
"equipment_model_id": "b9d55838-3b75-4f70-bbcf-41f2b344f032",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4555c18e-3e0a-41f1-98e2-ca968b9bfcf7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "03f86ecf-f33e-4e48-aa77-8788588ae333",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c05b30e3-8571-48e6-877d-97ec79ac7a4b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1560d581-edd7-4f7e-9170-6bbf49f97e2d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7367baf0-7e64-48df-9a15-5f574929fa85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2f0322a7-7463-4d20-8042-4b487b942302",
"db_currency_id": "14c8986c-19a2-4354-8261-aa6e51dac39e",
"db_language_id": "f34a204d-e16b-4438-9387-f24ad67be62e",
"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-09-17T07:14:20.3246011+00:00"
},
"modified_dateutc": "2026-09-17T07:14:20.3246011+00:00"
},
"equipment_family_id": "43e5a20f-0dab-46c0-b570-cd7f28daa131",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3be964cc-a9a6-408b-86fa-eb810df7271c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3edfd03d-e54d-4837-8048-856a082e9ccd",
"_parent_code": "sample string 6",
"sales_organization_id": "422381f0-f687-4342-8289-377c06e869bf",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7367baf0-7e64-48df-9a15-5f574929fa85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2f0322a7-7463-4d20-8042-4b487b942302",
"db_currency_id": "14c8986c-19a2-4354-8261-aa6e51dac39e",
"db_language_id": "f34a204d-e16b-4438-9387-f24ad67be62e",
"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-09-17T07:14:20.3246011+00:00"
},
"modified_dateutc": "2026-09-17T07:14:20.3246011+00:00"
},
"date_in_production_since": "2026-09-17T07:14:20.3246011+00:00",
"date_out_of_production_since": "2026-09-17T07:14:20.3246011+00:00",
"date_end_support": "2026-09-17T07:14:20.3246011+00:00",
"sales_organization_id": "2dc54126-c817-49d2-b957-2a4e77d3d51e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7367baf0-7e64-48df-9a15-5f574929fa85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2f0322a7-7463-4d20-8042-4b487b942302",
"db_currency_id": "14c8986c-19a2-4354-8261-aa6e51dac39e",
"db_language_id": "f34a204d-e16b-4438-9387-f24ad67be62e",
"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-09-17T07:14:20.3246011+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-09-17T07:14:20.3246011+00:00"
},
"project_status_id": "46490bd6-92d1-466c-94e8-313ec777c251",
"project_status_code": "sample string 10",
"project_status": {
"id": "cd0498cf-4fff-41e3-a285-56e42ab01810",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4fee37e0-e9f7-4c48-9a57-0c3371afde96",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7367baf0-7e64-48df-9a15-5f574929fa85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2f0322a7-7463-4d20-8042-4b487b942302",
"db_currency_id": "14c8986c-19a2-4354-8261-aa6e51dac39e",
"db_language_id": "f34a204d-e16b-4438-9387-f24ad67be62e",
"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-09-17T07:14:20.3246011+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-17T07:14:20.3246011+00:00"
},
"company_id": "68e87f70-1815-4ca1-9f83-e345409d106e",
"company_code": "sample string 12",
"db_address_id": "43b87a44-2936-4a2d-b54a-e0d0f2ea2bdf",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "42bf1dc6-f612-4651-9df2-2ded2c4d1775",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b1a551de-8e93-4666-a243-56c6f413380b",
"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-09-17T07:14:20.3246011+00:00",
"date_create": "2026-09-17T07:14:20.3246011+00:00",
"date_update": "2026-09-17T07:14:20.3246011+00:00",
"updated_by_user_id": "6b261bab-cf7f-448c-a665-ec7c925aaa95",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-17T07:14:20.3246011+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-09-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-17T07:14:20.3246011+00:00",
"date_last_job": "2026-09-17T07:14:20.3246011+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-17T07:14:20.3246011+00:00",
"modified_dateutc": "2026-09-17T07:14:20.3246011+00:00",
"is_mobile_installation": true
},
"job_type_id": "726323a5-5efe-4447-b5c8-c882d3099037",
"job_type_code": "sample string 7",
"job_type": {
"id": "a9db78ef-2eed-4704-91d1-a0fe600018f1",
"name": "sample string 2",
"sales_organization_id": "9d4de807-c7b7-4b58-91e4-ba93c3ff53a7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-17T07:14:20.3246011+00:00",
"code": "sample string 7"
},
"job_priority_id": "d45a9228-0436-4448-9489-ae1bf8a6f0c1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "665984a9-4eab-440d-854c-cd0118e8ae91",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "90d9283b-5842-4391-b361-2e6c919efc74",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7367baf0-7e64-48df-9a15-5f574929fa85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2f0322a7-7463-4d20-8042-4b487b942302",
"db_currency_id": "14c8986c-19a2-4354-8261-aa6e51dac39e",
"db_language_id": "f34a204d-e16b-4438-9387-f24ad67be62e",
"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-09-17T07:14:20.3246011+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-17T07:14:20.3246011+00:00"
},
"job_status_id": "69a24ef0-fc95-4d16-b6a2-436e85c1c048",
"job_status_code": "sample string 11",
"db_address_id": "76275496-43b4-4bda-bb60-d812ae1f7890",
"contact_id": "35a6f274-7e87-4911-b269-5b2f292f3bb1",
"requested_by_company_id": "c44460a3-b133-4f43-ab1d-dd9735117c97",
"requested_by_contact_id": "6592dfd5-6e9d-416e-9601-9686df4d2a9e",
"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-09-17T07:14:20.3246011+00:00",
"due_date": "2026-09-17T07:14:20.3246011+00:00",
"date_create": "2026-09-17T07:14:20.3246011+00:00",
"date_update": "2026-09-17T07:14:20.3246011+00:00",
"date_closed": "2026-09-17T07:14:20.3246011+00:00",
"suggested_user_id": "937af07f-2775-4ab0-a14a-6a383c74481f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0967ac2f-eea3-4d80-9676-a6447bae000f",
"db_language_id": "a9d28b46-c161-4e7b-8af8-d246f2ea4c1f",
"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-09-17T07:14:20.3246011+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "27f45549-dff8-4801-8da1-c6020c147be1",
"sales_organization": {
"id": "7367baf0-7e64-48df-9a15-5f574929fa85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2f0322a7-7463-4d20-8042-4b487b942302",
"db_currency_id": "14c8986c-19a2-4354-8261-aa6e51dac39e",
"db_language_id": "f34a204d-e16b-4438-9387-f24ad67be62e",
"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-09-17T07:14:20.3246011+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8c9e4fc0-f551-4cc2-b327-81759a9f1e4f",
"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": "bede6b5b-d72b-4f1d-98b4-e4800b7e3a66",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-17T07:14:20.3246011+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "61cb0b04-39ab-4967-9071-a9ebcf230bd4"
},
"suggested_date_start": "2026-09-17T07:14:20.3246011+00:00",
"skill_id": "ac2c2fd9-307d-44ae-97f4-c7efadbd5d83",
"skill_code": "sample string 32",
"skill": {
"id": "f254684f-c3e2-45eb-a25a-ce359bb109e8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "544feae0-aece-40cb-b8b3-719610e448d0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7367baf0-7e64-48df-9a15-5f574929fa85",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2f0322a7-7463-4d20-8042-4b487b942302",
"db_currency_id": "14c8986c-19a2-4354-8261-aa6e51dac39e",
"db_language_id": "f34a204d-e16b-4438-9387-f24ad67be62e",
"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-09-17T07:14:20.3246011+00:00"
},
"modified_dateutc": "2026-09-17T07:14:20.3246011+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "31b41d00-7bc2-4a3e-b5ee-272c8e300852",
"date_reported_by_company": "2026-09-17T07:14:20.3402225+00:00",
"id2": 36,
"company_id": "c362634d-cf84-47fa-81f1-3ac57beb4fae",
"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": "f7cebbd8-028a-41f5-b08a-7be4cd4ad301",
"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-09-17T07:14:20.3402225+00:00"
},
"work_instruction_details_id": "9b0e93b6-a391-4bc6-b61a-0df5a20aa388",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "40d89ff2-0325-4512-ad6b-6e0d69704bde",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f828ccf8-6431-4c15-95f4-e2e41ca75447",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-17T07:14:20.3402225+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": "bea3390f-5ecc-4c69-ab9a-d773cdbf4975",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-17T07:14:20.3402225+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.