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": "05e22ba2-6378-4d84-a038-aff543cc639a",
"jobs_id": "47578da6-deb4-4cfe-94bd-308da7fe68cc",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "71d370fa-7c58-4733-86c6-f5c9cd789ea9",
"_parent_id": "f7afe71f-25b1-44f5-8eb8-3b81f5aac7e8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "473fe54a-9021-4c6f-a5be-d28a7db230af",
"project_reference_back_office": "sample string 5",
"project": {
"id": "616ba6f3-56a3-4cd9-bea3-bea84e4e0baa",
"_parent_id": "4fb2946c-f1dd-4814-ad36-5ef0875432c0",
"root_parent_id": "b43b6742-f108-410e-aff5-c6c1887d18c7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d2554e31-d72d-4709-852a-d5bf30d706bb",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8357d639-9bea-4486-95af-3e53d9b561dd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6ab612a5-9a8a-4c48-a9d9-264a833bbca8",
"_parent_code": "sample string 6",
"sales_organization_id": "6162a773-7190-4180-be75-119436e874be",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7f5f1ab2-25d0-43d6-927a-a22423617f87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d81e1a42-1c8a-49f3-bf7f-8d221789f4ab",
"db_currency_id": "e7e524c4-e0ed-4a98-ac63-8819974dc0d2",
"db_language_id": "fa189eda-cadb-4d7f-80fd-6257788503e7",
"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-01-31T06:54:32.6767629+00:00"
},
"modified_dateutc": "2026-01-31T06:54:32.6767629+00:00"
},
"equipment_model_id": "807c68f4-7fda-4353-a16c-0676f76dcd64",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3915e97e-fc8f-454a-a1e7-815af8600a46",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9809f13d-7922-481a-acd8-299c227f32b4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4086e6cf-09df-44f3-bd6c-809868df05fe",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "77374ffb-6fe9-4320-8fda-c306a58e2003",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7f5f1ab2-25d0-43d6-927a-a22423617f87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d81e1a42-1c8a-49f3-bf7f-8d221789f4ab",
"db_currency_id": "e7e524c4-e0ed-4a98-ac63-8819974dc0d2",
"db_language_id": "fa189eda-cadb-4d7f-80fd-6257788503e7",
"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-01-31T06:54:32.6767629+00:00"
},
"modified_dateutc": "2026-01-31T06:54:32.6767629+00:00"
},
"equipment_family_id": "601ee278-cd27-4055-83f6-d0067d740b3c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8357d639-9bea-4486-95af-3e53d9b561dd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6ab612a5-9a8a-4c48-a9d9-264a833bbca8",
"_parent_code": "sample string 6",
"sales_organization_id": "6162a773-7190-4180-be75-119436e874be",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7f5f1ab2-25d0-43d6-927a-a22423617f87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d81e1a42-1c8a-49f3-bf7f-8d221789f4ab",
"db_currency_id": "e7e524c4-e0ed-4a98-ac63-8819974dc0d2",
"db_language_id": "fa189eda-cadb-4d7f-80fd-6257788503e7",
"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-01-31T06:54:32.6767629+00:00"
},
"modified_dateutc": "2026-01-31T06:54:32.6767629+00:00"
},
"date_in_production_since": "2026-01-31T06:54:32.6767629+00:00",
"date_out_of_production_since": "2026-01-31T06:54:32.6767629+00:00",
"date_end_support": "2026-01-31T06:54:32.6767629+00:00",
"sales_organization_id": "dec1eb1b-15d1-4cd0-a682-b16a04f3cb19",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7f5f1ab2-25d0-43d6-927a-a22423617f87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d81e1a42-1c8a-49f3-bf7f-8d221789f4ab",
"db_currency_id": "e7e524c4-e0ed-4a98-ac63-8819974dc0d2",
"db_language_id": "fa189eda-cadb-4d7f-80fd-6257788503e7",
"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-01-31T06:54:32.6767629+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-01-31T06:54:32.6923949+00:00"
},
"project_status_id": "3807b7b8-86e2-4f96-9728-98203288b500",
"project_status_code": "sample string 10",
"project_status": {
"id": "6f749494-007b-4cfb-bd89-1e56dd01e6e8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9c6c16b6-f605-4034-adf0-6f4caccf1c5f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7f5f1ab2-25d0-43d6-927a-a22423617f87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d81e1a42-1c8a-49f3-bf7f-8d221789f4ab",
"db_currency_id": "e7e524c4-e0ed-4a98-ac63-8819974dc0d2",
"db_language_id": "fa189eda-cadb-4d7f-80fd-6257788503e7",
"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-01-31T06:54:32.6767629+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-31T06:54:32.6923949+00:00"
},
"company_id": "7368df60-77b9-4de7-9f43-e4c475c87e10",
"company_code": "sample string 12",
"db_address_id": "b677ede2-e5db-4aef-85b9-7f24bdd389f2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "145bae50-b1de-4fd3-aa47-82b7dabdb4f5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b8c4aee3-6fba-475e-a05c-93070d95f9bb",
"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-01-31T06:54:32.6923949+00:00",
"date_create": "2026-01-31T06:54:32.6923949+00:00",
"date_update": "2026-01-31T06:54:32.6923949+00:00",
"updated_by_user_id": "49d350e3-724b-47c1-a984-dfdd78ee2b50",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-31T06:54:32.6923949+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-01-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-31T06:54:32.6923949+00:00",
"date_last_job": "2026-01-31T06:54:32.6923949+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-31T06:54:32.6923949+00:00",
"modified_dateutc": "2026-01-31T06:54:32.6923949+00:00",
"is_mobile_installation": true
},
"job_type_id": "66c6d102-9c49-445d-86d8-6c6f0de1df26",
"job_type_code": "sample string 7",
"job_type": {
"id": "d650af4e-7f88-48a3-b203-317148e984df",
"name": "sample string 2",
"sales_organization_id": "472e5119-6b9f-457b-9795-0f4c91a95ec4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-31T06:54:32.6923949+00:00",
"code": "sample string 7"
},
"job_priority_id": "24a2e5d9-68fe-44b1-99e0-dca245f74456",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9cd0cd4d-3b1c-4fb4-a7a8-939587155d2a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "821a29ea-08aa-4eb8-b160-7714d502b239",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7f5f1ab2-25d0-43d6-927a-a22423617f87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d81e1a42-1c8a-49f3-bf7f-8d221789f4ab",
"db_currency_id": "e7e524c4-e0ed-4a98-ac63-8819974dc0d2",
"db_language_id": "fa189eda-cadb-4d7f-80fd-6257788503e7",
"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-01-31T06:54:32.6767629+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-31T06:54:32.6923949+00:00"
},
"job_status_id": "1c951b92-9e55-49d0-a170-99ccb8f15e93",
"job_status_code": "sample string 11",
"db_address_id": "75932815-7273-47c0-94c0-d428c6305575",
"contact_id": "0e4a2297-eb9a-4f31-8610-e93bf9c15e34",
"requested_by_company_id": "78ce6a2e-e995-42f8-897b-76f30043a165",
"requested_by_contact_id": "7f2acf78-3d2c-4693-9c2d-702f31e5c80c",
"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-01-31T06:54:32.6923949+00:00",
"due_date": "2026-01-31T06:54:32.6923949+00:00",
"date_create": "2026-01-31T06:54:32.6923949+00:00",
"date_update": "2026-01-31T06:54:32.6923949+00:00",
"date_closed": "2026-01-31T06:54:32.6923949+00:00",
"suggested_user_id": "7c2cc127-baa0-4eb0-9e6d-31efb4ce1ee0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4cb12024-fbf9-4fe1-8039-3f94f4bbb0ff",
"db_language_id": "efc3b110-853d-451d-8b53-402047cad9a3",
"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-01-31T06:54:32.6923949+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "db9911f9-bb67-460e-bcec-83d115e9b08d",
"sales_organization": {
"id": "7f5f1ab2-25d0-43d6-927a-a22423617f87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d81e1a42-1c8a-49f3-bf7f-8d221789f4ab",
"db_currency_id": "e7e524c4-e0ed-4a98-ac63-8819974dc0d2",
"db_language_id": "fa189eda-cadb-4d7f-80fd-6257788503e7",
"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-01-31T06:54:32.6767629+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "db3e3268-eb3b-4f87-84dc-810195bda28f",
"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": "4e05a797-327a-4b9f-bee4-74eb029a4983",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-31T06:54:32.6923949+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9bfa99e4-95c9-4c70-8eec-b57ed4b5325b"
},
"suggested_date_start": "2026-01-31T06:54:32.6923949+00:00",
"skill_id": "ad1698c7-6eb8-4726-967e-53a71facfb8c",
"skill_code": "sample string 32",
"skill": {
"id": "47ce041f-50bc-4503-ab93-454f0f9c0f79",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b1ca2a06-3466-48fc-9c5e-ca1df081f863",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7f5f1ab2-25d0-43d6-927a-a22423617f87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d81e1a42-1c8a-49f3-bf7f-8d221789f4ab",
"db_currency_id": "e7e524c4-e0ed-4a98-ac63-8819974dc0d2",
"db_language_id": "fa189eda-cadb-4d7f-80fd-6257788503e7",
"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-01-31T06:54:32.6767629+00:00"
},
"modified_dateutc": "2026-01-31T06:54:32.6923949+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "416c2529-1fce-41f7-b9a1-07ac7a390b0b",
"date_reported_by_company": "2026-01-31T06:54:32.6923949+00:00",
"id2": 36,
"company_id": "6121a5c8-99d5-4f87-b0fd-afd898a92abb",
"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": "7862ff2c-c835-47b9-8218-c9921aa39718",
"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-01-31T06:54:32.6923949+00:00"
},
"work_instruction_details_id": "ca4a2a16-623f-4192-b84b-a4587795bbac",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "79db136e-3c9f-4112-b6a6-3b2212d035a3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7aece3cd-f3b2-4b0d-a388-2e90cc0c0d36",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-31T06:54:32.6923949+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": "3e964f63-5065-491a-9ae9-b6e31d445ea8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-31T06:54:32.6923949+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.