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": "10c3cd65-50b5-4104-b94f-298f194a96e0",
"jobs_id": "4dde232c-0af0-47c3-89e0-e568a36659d3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a8d95084-69c9-4cce-a1f6-dbe9dde1d43c",
"_parent_id": "c6c91a1c-b50c-4ce1-863b-3ad943a947ca",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1978e193-550b-420c-9a2a-2c529b394f1b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "54a1cb13-0080-48be-a817-8671fcfb59bc",
"_parent_id": "ed077a59-d770-4faa-a651-51d4496b3636",
"root_parent_id": "d51d47b3-9f55-4d94-8334-8abdeac5522b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0588e014-4b82-465a-91f9-a9bba10c14ab",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ac91a2de-7530-4a53-a283-0b24c8774fca",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "637ab747-36b7-422d-bb7c-12cc54de5bc7",
"_parent_code": "sample string 6",
"sales_organization_id": "9f537a84-3a42-4c6a-8434-c8d7fed25b2c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "285e757c-12d8-409d-b08f-453d11b28a9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29775561-577b-47c5-9b5c-1e04713d5dfb",
"db_currency_id": "4724650b-8ddb-43d8-a83a-f3ff5194a93f",
"db_language_id": "a64feca8-56e7-44e4-8840-ab3f3592c627",
"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-11-06T07:47:25.8836369+00:00"
},
"modified_dateutc": "2026-11-06T07:47:25.9031051+00:00"
},
"equipment_model_id": "ab86aee7-72d8-42b3-af71-009f22e611a7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e9b50d70-db12-41d9-90f8-6e65ae82f698",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "266c73f5-c229-4e87-931f-b454f932a567",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "20d25f75-a275-4396-99f7-03e6cd21f31b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9c54e7fb-a647-4480-982c-cb6211b3fbe2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "285e757c-12d8-409d-b08f-453d11b28a9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29775561-577b-47c5-9b5c-1e04713d5dfb",
"db_currency_id": "4724650b-8ddb-43d8-a83a-f3ff5194a93f",
"db_language_id": "a64feca8-56e7-44e4-8840-ab3f3592c627",
"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-11-06T07:47:25.8836369+00:00"
},
"modified_dateutc": "2026-11-06T07:47:25.9142375+00:00"
},
"equipment_family_id": "f9402f5b-36d9-4a60-b9ed-26791d713322",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ac91a2de-7530-4a53-a283-0b24c8774fca",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "637ab747-36b7-422d-bb7c-12cc54de5bc7",
"_parent_code": "sample string 6",
"sales_organization_id": "9f537a84-3a42-4c6a-8434-c8d7fed25b2c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "285e757c-12d8-409d-b08f-453d11b28a9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29775561-577b-47c5-9b5c-1e04713d5dfb",
"db_currency_id": "4724650b-8ddb-43d8-a83a-f3ff5194a93f",
"db_language_id": "a64feca8-56e7-44e4-8840-ab3f3592c627",
"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-11-06T07:47:25.8836369+00:00"
},
"modified_dateutc": "2026-11-06T07:47:25.9031051+00:00"
},
"date_in_production_since": "2026-11-06T07:47:25.9142375+00:00",
"date_out_of_production_since": "2026-11-06T07:47:25.9142375+00:00",
"date_end_support": "2026-11-06T07:47:25.9142375+00:00",
"sales_organization_id": "5439e26f-56a4-40bb-8ae4-4c667951780f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "285e757c-12d8-409d-b08f-453d11b28a9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29775561-577b-47c5-9b5c-1e04713d5dfb",
"db_currency_id": "4724650b-8ddb-43d8-a83a-f3ff5194a93f",
"db_language_id": "a64feca8-56e7-44e4-8840-ab3f3592c627",
"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-11-06T07:47:25.8836369+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-11-06T07:47:25.9323127+00:00"
},
"project_status_id": "68ea45fe-02b5-430f-80b0-f5db395b1e66",
"project_status_code": "sample string 10",
"project_status": {
"id": "cd6706bd-e42d-4f0a-a79c-45d5e06bc393",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cdae95b2-488d-419c-9e9e-26eea1855d1e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "285e757c-12d8-409d-b08f-453d11b28a9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29775561-577b-47c5-9b5c-1e04713d5dfb",
"db_currency_id": "4724650b-8ddb-43d8-a83a-f3ff5194a93f",
"db_language_id": "a64feca8-56e7-44e4-8840-ab3f3592c627",
"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-11-06T07:47:25.8836369+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-06T07:47:25.9323127+00:00"
},
"company_id": "f9409b37-dda6-4ac9-bee1-86b246c5d9de",
"company_code": "sample string 12",
"db_address_id": "a8882a87-1c2a-439c-b37b-2d14a57cf21d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "648866cd-d496-4154-941b-1860f9bd27e0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3e30f6cc-03ce-4a19-97d1-f3b690588c60",
"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-11-06T07:47:25.9454903+00:00",
"date_create": "2026-11-06T07:47:25.9454903+00:00",
"date_update": "2026-11-06T07:47:25.9454903+00:00",
"updated_by_user_id": "42d58402-29be-43b0-ab41-d7d9b0733871",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-06T07:47:25.9454903+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-11-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-06T07:47:25.9454903+00:00",
"date_last_job": "2026-11-06T07:47:25.9454903+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-06T07:47:25.9454903+00:00",
"modified_dateutc": "2026-11-06T07:47:25.9454903+00:00",
"is_mobile_installation": true
},
"job_type_id": "2b21a9e7-7e36-456e-b0de-2eed49320cee",
"job_type_code": "sample string 7",
"job_type": {
"id": "d244d635-d532-4fe2-a06b-a488c0860ddd",
"name": "sample string 2",
"sales_organization_id": "da9af47c-1261-4577-8cd8-039d4827f5ff",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-06T07:47:25.9454903+00:00",
"code": "sample string 7"
},
"job_priority_id": "0e54157e-2738-4ce3-bed0-ce4ee2291397",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e76d02ed-835f-4e9b-8b44-292c5a169aa5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fd7bd9af-2fd2-47db-83de-95512199b3ec",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "285e757c-12d8-409d-b08f-453d11b28a9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29775561-577b-47c5-9b5c-1e04713d5dfb",
"db_currency_id": "4724650b-8ddb-43d8-a83a-f3ff5194a93f",
"db_language_id": "a64feca8-56e7-44e4-8840-ab3f3592c627",
"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-11-06T07:47:25.8836369+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-06T07:47:25.9454903+00:00"
},
"job_status_id": "20fb3918-77d0-4f18-986b-1577722cd355",
"job_status_code": "sample string 11",
"db_address_id": "fbb57b7a-54df-4107-982e-7fabe8212ac5",
"contact_id": "930fbad1-13f9-4606-aa1d-f8b5c7d32ec7",
"requested_by_company_id": "6a78e879-dfe4-4b3c-8f37-ba79bfb91271",
"requested_by_contact_id": "c12b28b6-a090-42ab-8d79-ba8508f7905b",
"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-11-06T07:47:25.9454903+00:00",
"due_date": "2026-11-06T07:47:25.9454903+00:00",
"date_create": "2026-11-06T07:47:25.9611361+00:00",
"date_update": "2026-11-06T07:47:25.9611361+00:00",
"date_closed": "2026-11-06T07:47:25.9611361+00:00",
"suggested_user_id": "871d4336-7e04-400c-801f-23e1431ddaa0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b7d12e43-7d4c-4565-892e-506f8284b8d8",
"db_language_id": "39d5676d-a97a-4ee7-873d-58faceeb6f8c",
"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-11-06T07:47:25.9611361+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a6455dbf-2038-44e3-8d95-d1149323e791",
"sales_organization": {
"id": "285e757c-12d8-409d-b08f-453d11b28a9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29775561-577b-47c5-9b5c-1e04713d5dfb",
"db_currency_id": "4724650b-8ddb-43d8-a83a-f3ff5194a93f",
"db_language_id": "a64feca8-56e7-44e4-8840-ab3f3592c627",
"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-11-06T07:47:25.8836369+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ab21dbbf-388b-49d3-b333-b2c19810dea7",
"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": "0b5f0fb0-db05-4a69-b505-7fdd0e94b38a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-06T07:47:25.9611361+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2d6be107-0dc3-4927-808d-8e78d3d7377f"
},
"suggested_date_start": "2026-11-06T07:47:25.9611361+00:00",
"skill_id": "b26e3032-9a37-4cad-8507-ddefdc406784",
"skill_code": "sample string 32",
"skill": {
"id": "3fd90c60-1770-4a3d-b0f3-549a4c92fdc5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4d7f7b72-46a5-46b3-b211-c253502d346f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "285e757c-12d8-409d-b08f-453d11b28a9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "29775561-577b-47c5-9b5c-1e04713d5dfb",
"db_currency_id": "4724650b-8ddb-43d8-a83a-f3ff5194a93f",
"db_language_id": "a64feca8-56e7-44e4-8840-ab3f3592c627",
"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-11-06T07:47:25.8836369+00:00"
},
"modified_dateutc": "2026-11-06T07:47:25.9611361+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "11488dea-eba4-4b5f-a184-41e7197edcb6",
"date_reported_by_company": "2026-11-06T07:47:25.9611361+00:00",
"id2": 36,
"company_id": "4c5c9c84-d9d9-4834-8b56-07b4bb3b7efc",
"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": "bcf8b69e-b57b-4181-9e84-9aebd1a48789",
"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-11-06T07:47:25.9611361+00:00"
},
"work_instruction_details_id": "6629b43d-f54b-4ae4-ba6d-2e2cc161406a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "48be61a3-99ca-4496-9b36-2ed5f02cfd86",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e697922f-0c1e-4b19-be95-3bca8194c234",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-06T07:47:25.9611361+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": "ff204aef-4503-4a05-a61e-df44f7397d9c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-06T07:47:25.9611361+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.