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": "cabd04fd-0411-4caa-9241-49e5d775ba03",
"jobs_id": "ab318fd8-213b-4ffb-8079-dbf8b1620681",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "47d5f8af-4cc5-4106-9a06-56386a734e9c",
"_parent_id": "5dd0fe03-ed18-484d-82ab-a86694e2818f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "725e3c06-9d8c-4591-ad0d-9ec8c83232de",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1861c149-adef-4e9f-a168-79cec7a2c837",
"_parent_id": "bf3f6729-d9cb-4c11-affd-4c5913012985",
"root_parent_id": "d98bf560-fe52-4b20-8eb0-254ff361fd41",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "dbdb4b0e-92ef-4eeb-a523-5b04c50fb82a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "16609dec-0232-4186-9cbe-a84a70afc812",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f3246303-6917-48af-99f5-1491180e2394",
"_parent_code": "sample string 6",
"sales_organization_id": "824f0d09-13bb-4a01-99f2-c0d9e32c1f6d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b5e49f37-35e8-46da-866c-5c542bf5e648",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9c42c46-83dc-46b2-8d61-b5791320b965",
"db_currency_id": "5352a6ac-6d28-4856-ab07-c2ac0a010ca9",
"db_language_id": "53e21091-9f9b-48c4-be62-e7f37ef4f2c6",
"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-08-30T00:25:14.7864314+00:00"
},
"modified_dateutc": "2026-08-30T00:25:14.7864314+00:00"
},
"equipment_model_id": "c3409861-5a29-406e-b51e-b70a89012761",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "20803562-45ab-4fb5-823e-3a1a724b5449",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "319d0f47-30ca-4be1-a5ca-76704a774bc1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6a8f6bc4-5adb-40d1-b670-45c457347079",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "01a977c3-ca6d-47aa-aa94-c2a190ca9fda",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b5e49f37-35e8-46da-866c-5c542bf5e648",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9c42c46-83dc-46b2-8d61-b5791320b965",
"db_currency_id": "5352a6ac-6d28-4856-ab07-c2ac0a010ca9",
"db_language_id": "53e21091-9f9b-48c4-be62-e7f37ef4f2c6",
"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-08-30T00:25:14.7864314+00:00"
},
"modified_dateutc": "2026-08-30T00:25:14.7864314+00:00"
},
"equipment_family_id": "9c3056b9-1a95-427a-9120-89a0d5ef71a0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "16609dec-0232-4186-9cbe-a84a70afc812",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f3246303-6917-48af-99f5-1491180e2394",
"_parent_code": "sample string 6",
"sales_organization_id": "824f0d09-13bb-4a01-99f2-c0d9e32c1f6d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b5e49f37-35e8-46da-866c-5c542bf5e648",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9c42c46-83dc-46b2-8d61-b5791320b965",
"db_currency_id": "5352a6ac-6d28-4856-ab07-c2ac0a010ca9",
"db_language_id": "53e21091-9f9b-48c4-be62-e7f37ef4f2c6",
"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-08-30T00:25:14.7864314+00:00"
},
"modified_dateutc": "2026-08-30T00:25:14.7864314+00:00"
},
"date_in_production_since": "2026-08-30T00:25:14.7864314+00:00",
"date_out_of_production_since": "2026-08-30T00:25:14.7864314+00:00",
"date_end_support": "2026-08-30T00:25:14.7864314+00:00",
"sales_organization_id": "542fd64f-dea9-479c-b605-8946e707c44b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b5e49f37-35e8-46da-866c-5c542bf5e648",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9c42c46-83dc-46b2-8d61-b5791320b965",
"db_currency_id": "5352a6ac-6d28-4856-ab07-c2ac0a010ca9",
"db_language_id": "53e21091-9f9b-48c4-be62-e7f37ef4f2c6",
"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-08-30T00:25:14.7864314+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-08-30T00:25:14.7864314+00:00"
},
"project_status_id": "0844fb3f-e1a5-4c1e-ab16-d3461bfac1f6",
"project_status_code": "sample string 10",
"project_status": {
"id": "eb78fb05-5706-4785-9b29-c066e542c099",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9ed06707-3f86-45a2-b1c0-7c2b40624fa5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b5e49f37-35e8-46da-866c-5c542bf5e648",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9c42c46-83dc-46b2-8d61-b5791320b965",
"db_currency_id": "5352a6ac-6d28-4856-ab07-c2ac0a010ca9",
"db_language_id": "53e21091-9f9b-48c4-be62-e7f37ef4f2c6",
"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-08-30T00:25:14.7864314+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-30T00:25:14.7864314+00:00"
},
"company_id": "62dcf320-a907-4505-a30d-8fbbae799c26",
"company_code": "sample string 12",
"db_address_id": "d7ad4b62-6833-4698-9dd3-603941908ea1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "51cfabe8-eb0d-4b0e-8a65-8e1ca993485c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "aec4f856-0288-455a-9432-e0d9d03c89d5",
"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-08-30T00:25:14.7864314+00:00",
"date_create": "2026-08-30T00:25:14.7864314+00:00",
"date_update": "2026-08-30T00:25:14.7864314+00:00",
"updated_by_user_id": "893cad57-c84c-4c7a-93cb-314f7c5ccec0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-30T00:25:14.7864314+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-08-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-30T00:25:14.7864314+00:00",
"date_last_job": "2026-08-30T00:25:14.7864314+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-30T00:25:14.7864314+00:00",
"modified_dateutc": "2026-08-30T00:25:14.7864314+00:00",
"is_mobile_installation": true
},
"job_type_id": "3492b5e8-e973-4704-a2b9-2b835b107e3d",
"job_type_code": "sample string 7",
"job_type": {
"id": "8e4c455a-5efc-42a9-8b05-03cfc20520b9",
"name": "sample string 2",
"sales_organization_id": "ba5a8ea9-573e-425d-8b6b-8dede17e3cd5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-30T00:25:14.7864314+00:00",
"code": "sample string 7"
},
"job_priority_id": "d7fdf277-1ccb-4c15-bf87-266ffe525b2f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d092ef63-bda8-4c0e-87e1-a4f043ab1e53",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d50eab70-144e-4e89-84b4-435c3acf13e5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b5e49f37-35e8-46da-866c-5c542bf5e648",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9c42c46-83dc-46b2-8d61-b5791320b965",
"db_currency_id": "5352a6ac-6d28-4856-ab07-c2ac0a010ca9",
"db_language_id": "53e21091-9f9b-48c4-be62-e7f37ef4f2c6",
"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-08-30T00:25:14.7864314+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-30T00:25:14.7864314+00:00"
},
"job_status_id": "c43af127-3506-4b65-83be-7e6dd0a6c6f3",
"job_status_code": "sample string 11",
"db_address_id": "f4afceef-ce3a-46fd-871c-b8edd305dadf",
"contact_id": "d80f232a-496d-4c16-9e5d-6ca937d59cdf",
"requested_by_company_id": "a6dadc52-564a-4c50-b3ef-ccd9c5c2b1f4",
"requested_by_contact_id": "01ea14ee-5639-465d-9480-9570a11fe13e",
"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-08-30T00:25:14.7864314+00:00",
"due_date": "2026-08-30T00:25:14.7864314+00:00",
"date_create": "2026-08-30T00:25:14.7864314+00:00",
"date_update": "2026-08-30T00:25:14.7864314+00:00",
"date_closed": "2026-08-30T00:25:14.7864314+00:00",
"suggested_user_id": "79e19237-95ef-4590-99a6-ea3fd6dc4409",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d0615dfd-073b-40fd-926e-8c2f18f732b9",
"db_language_id": "2d8083ca-0692-410a-8885-3fddba266484",
"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-08-30T00:25:14.7864314+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "91c41110-0682-4668-b54f-5f1abb38f012",
"sales_organization": {
"id": "b5e49f37-35e8-46da-866c-5c542bf5e648",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9c42c46-83dc-46b2-8d61-b5791320b965",
"db_currency_id": "5352a6ac-6d28-4856-ab07-c2ac0a010ca9",
"db_language_id": "53e21091-9f9b-48c4-be62-e7f37ef4f2c6",
"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-08-30T00:25:14.7864314+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "79b530de-b486-4ceb-b770-1ed39fa8ed7a",
"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": "20f67f0d-f7a5-4325-944b-f6cdc5757585",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-30T00:25:14.7864314+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4071b5da-ef1d-4057-9230-17fd98b41ded"
},
"suggested_date_start": "2026-08-30T00:25:14.7864314+00:00",
"skill_id": "e466da34-7e01-41a9-8962-a9d643172f2d",
"skill_code": "sample string 32",
"skill": {
"id": "e177837a-1d92-427f-8e25-f1a8eb411a7d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2b987184-6691-410b-b2ee-59eec575ac9b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b5e49f37-35e8-46da-866c-5c542bf5e648",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f9c42c46-83dc-46b2-8d61-b5791320b965",
"db_currency_id": "5352a6ac-6d28-4856-ab07-c2ac0a010ca9",
"db_language_id": "53e21091-9f9b-48c4-be62-e7f37ef4f2c6",
"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-08-30T00:25:14.7864314+00:00"
},
"modified_dateutc": "2026-08-30T00:25:14.7864314+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8344d430-ca9f-4542-8e8e-6c015bf7e96a",
"date_reported_by_company": "2026-08-30T00:25:14.7864314+00:00",
"id2": 36,
"company_id": "904c1ee1-613d-45ce-92f8-4e954facc557",
"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": "71a7b791-dc18-414b-bd7c-c4f43f3653b9",
"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-08-30T00:25:14.8020551+00:00"
},
"work_instruction_details_id": "9b659fa9-fa06-4a2a-b649-a271b1120266",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "81e5abde-0bcd-4238-b9c2-dc885168ba45",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6bd7d05c-10bd-491f-a123-4fa1e955223a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-30T00:25:14.8020551+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": "80443711-4279-4329-a7a9-da16966055e3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-30T00:25:14.8020551+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.