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": "5e29827e-e1d0-4db6-be39-26235b0aeac8",
"jobs_id": "8961d559-82f0-46a7-8c99-d0b929271c89",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b0e27de4-edfe-49fd-aa76-663e91cb174a",
"_parent_id": "27447d66-9aff-44d6-84ff-abbcf97b6122",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a944fd3f-17e3-42ec-8f8d-cd47cabf22c1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "aae7b5c8-4ea6-40f1-9e08-dd97cb7c9c9f",
"_parent_id": "efc2d051-af7d-4cc6-8072-f9ffeabc6e12",
"root_parent_id": "87e131fa-4ba7-41d4-be25-623de309b106",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a0c4e1d6-017a-4161-915b-82fd6700d0f8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6b1062f0-ff0e-4ab1-9d61-34033081976c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "342d575f-72ef-454c-af6a-977123e9d46c",
"_parent_code": "sample string 6",
"sales_organization_id": "6fcdd967-5197-4fe0-ae41-3acf9f304052",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f83f20b2-728f-42b5-8344-fe8abf674f9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8830b380-4988-48ca-878e-b70871b119b2",
"db_currency_id": "81d0f45d-4c75-4824-a86b-df1eae1b0e76",
"db_language_id": "64888df5-59ad-4cdc-946c-96a4f2920925",
"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-04-23T08:55:44.6482606+00:00"
},
"modified_dateutc": "2026-04-23T08:55:44.6482606+00:00"
},
"equipment_model_id": "13dafd24-9427-4f5f-956c-fa9f48916565",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "40a651cf-8c39-49bb-ad71-b566a963a360",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5f313119-488e-4478-b7c5-20ce112d3fa0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "939106d3-2b39-4b66-89e2-5bcd01294a55",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "63601b1a-cfec-4cda-b8cd-a0adfebc63cc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f83f20b2-728f-42b5-8344-fe8abf674f9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8830b380-4988-48ca-878e-b70871b119b2",
"db_currency_id": "81d0f45d-4c75-4824-a86b-df1eae1b0e76",
"db_language_id": "64888df5-59ad-4cdc-946c-96a4f2920925",
"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-04-23T08:55:44.6482606+00:00"
},
"modified_dateutc": "2026-04-23T08:55:44.6482606+00:00"
},
"equipment_family_id": "b50d3a47-f885-487b-b69a-9b84692b47b4",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6b1062f0-ff0e-4ab1-9d61-34033081976c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "342d575f-72ef-454c-af6a-977123e9d46c",
"_parent_code": "sample string 6",
"sales_organization_id": "6fcdd967-5197-4fe0-ae41-3acf9f304052",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f83f20b2-728f-42b5-8344-fe8abf674f9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8830b380-4988-48ca-878e-b70871b119b2",
"db_currency_id": "81d0f45d-4c75-4824-a86b-df1eae1b0e76",
"db_language_id": "64888df5-59ad-4cdc-946c-96a4f2920925",
"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-04-23T08:55:44.6482606+00:00"
},
"modified_dateutc": "2026-04-23T08:55:44.6482606+00:00"
},
"date_in_production_since": "2026-04-23T08:55:44.6482606+00:00",
"date_out_of_production_since": "2026-04-23T08:55:44.6482606+00:00",
"date_end_support": "2026-04-23T08:55:44.6482606+00:00",
"sales_organization_id": "58393fd4-2417-406e-85a0-1be3e2d7a3fa",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f83f20b2-728f-42b5-8344-fe8abf674f9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8830b380-4988-48ca-878e-b70871b119b2",
"db_currency_id": "81d0f45d-4c75-4824-a86b-df1eae1b0e76",
"db_language_id": "64888df5-59ad-4cdc-946c-96a4f2920925",
"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-04-23T08:55:44.6482606+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-04-23T08:55:44.6482606+00:00"
},
"project_status_id": "03a0eea4-6514-4745-b0f8-6b3684cb79bc",
"project_status_code": "sample string 10",
"project_status": {
"id": "878f8979-b72e-424d-baf1-79d5259b48d7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "89b0d7b2-9c74-4adc-8099-5f5a1e06ba39",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f83f20b2-728f-42b5-8344-fe8abf674f9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8830b380-4988-48ca-878e-b70871b119b2",
"db_currency_id": "81d0f45d-4c75-4824-a86b-df1eae1b0e76",
"db_language_id": "64888df5-59ad-4cdc-946c-96a4f2920925",
"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-04-23T08:55:44.6482606+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-23T08:55:44.6482606+00:00"
},
"company_id": "f5fcdfc4-3533-4260-b2d4-6e84afd58d98",
"company_code": "sample string 12",
"db_address_id": "54b5c6d9-fce5-4865-9fd1-ce64d892f35e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6cc79cc4-f2cd-4247-a1cc-ede72519863b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "57a4f2cb-b4ef-4d99-a4c7-2e12698d9274",
"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-04-23T08:55:44.6482606+00:00",
"date_create": "2026-04-23T08:55:44.6482606+00:00",
"date_update": "2026-04-23T08:55:44.6482606+00:00",
"updated_by_user_id": "db878a4f-06a5-4315-9c55-96eeccdf3e48",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-23T08:55:44.6482606+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-04-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-23T08:55:44.6482606+00:00",
"date_last_job": "2026-04-23T08:55:44.6482606+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-23T08:55:44.6482606+00:00",
"modified_dateutc": "2026-04-23T08:55:44.6482606+00:00",
"is_mobile_installation": true
},
"job_type_id": "f0bfca21-6f11-44fd-8c24-da2705be66d7",
"job_type_code": "sample string 7",
"job_type": {
"id": "95276962-844b-47cb-adf7-a4d8ac70e731",
"name": "sample string 2",
"sales_organization_id": "a294cb0f-f2f6-49fb-b5c8-0ba66054121e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-23T08:55:44.6482606+00:00",
"code": "sample string 7"
},
"job_priority_id": "b3cbad96-639a-43ac-b1eb-91140d4333c2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4b1e2da1-51e6-4397-a59e-293870d1f045",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "56d4bf48-8cae-4e7f-aa54-1b4cfd5b517d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f83f20b2-728f-42b5-8344-fe8abf674f9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8830b380-4988-48ca-878e-b70871b119b2",
"db_currency_id": "81d0f45d-4c75-4824-a86b-df1eae1b0e76",
"db_language_id": "64888df5-59ad-4cdc-946c-96a4f2920925",
"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-04-23T08:55:44.6482606+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-23T08:55:44.6482606+00:00"
},
"job_status_id": "486b6e12-dd1c-46d0-8855-db8cf704ee48",
"job_status_code": "sample string 11",
"db_address_id": "49ac7420-602c-4069-ac77-2eb5709f23c6",
"contact_id": "e39bc9ef-09a3-4706-89aa-9ab0a03bdbd3",
"requested_by_company_id": "b8dcb32b-c8b4-40b1-a416-03b0d86c0810",
"requested_by_contact_id": "521660bc-a2c3-449e-b9d2-163b9a3cd2bc",
"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-04-23T08:55:44.6482606+00:00",
"due_date": "2026-04-23T08:55:44.6482606+00:00",
"date_create": "2026-04-23T08:55:44.6482606+00:00",
"date_update": "2026-04-23T08:55:44.6482606+00:00",
"date_closed": "2026-04-23T08:55:44.6482606+00:00",
"suggested_user_id": "c80d1824-d737-4144-a690-c06a1d6dce2f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "29550447-87e2-476e-ae58-a28067717c88",
"db_language_id": "b2065d78-8620-45c6-bfdc-5fd06e2a034b",
"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-04-23T08:55:44.6482606+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a971230e-79fe-44a0-80d1-e6dafde811a2",
"sales_organization": {
"id": "f83f20b2-728f-42b5-8344-fe8abf674f9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8830b380-4988-48ca-878e-b70871b119b2",
"db_currency_id": "81d0f45d-4c75-4824-a86b-df1eae1b0e76",
"db_language_id": "64888df5-59ad-4cdc-946c-96a4f2920925",
"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-04-23T08:55:44.6482606+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3bcce576-f77b-4bde-a0d3-40f1bd7a590f",
"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": "0293e9bb-9359-4dcf-93d9-3ccbd470c6f5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-23T08:55:44.6482606+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5d922892-c413-4c4c-ab84-03233efce81c"
},
"suggested_date_start": "2026-04-23T08:55:44.6482606+00:00",
"skill_id": "6dde165c-25b6-448b-b903-fbd02fbd0791",
"skill_code": "sample string 32",
"skill": {
"id": "4c6ebc5c-9847-458c-8fa8-0643dde23e67",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9e5ac4d8-2f3e-44f2-a45b-3c2d7117d244",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f83f20b2-728f-42b5-8344-fe8abf674f9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8830b380-4988-48ca-878e-b70871b119b2",
"db_currency_id": "81d0f45d-4c75-4824-a86b-df1eae1b0e76",
"db_language_id": "64888df5-59ad-4cdc-946c-96a4f2920925",
"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-04-23T08:55:44.6482606+00:00"
},
"modified_dateutc": "2026-04-23T08:55:44.6482606+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e8a25622-b5fb-4c3c-ad8d-cea87d24d91e",
"date_reported_by_company": "2026-04-23T08:55:44.6482606+00:00",
"id2": 36,
"company_id": "aaefa534-1167-4df3-aaa8-12541ffce5f6",
"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": "071ba45a-694d-40e2-a944-ff5ebbe03bd3",
"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-04-23T08:55:44.6482606+00:00"
},
"work_instruction_details_id": "ceee76a8-ff7b-45cf-9265-68f8c9ee34f0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "282a2c2a-3ff4-43d4-b764-1f77d5983b13",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0b4fea1b-cc20-4a6f-9f0a-4239d93cb546",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-23T08:55:44.6482606+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": "51d193ec-21d7-459f-836e-af75a4ed9d2e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-23T08:55:44.6638874+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.