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": "ca019e5e-0008-49cd-8609-d758c0228f75",
"jobs_id": "ff76c3f2-2d54-427d-a2ac-12c4bec6a227",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "13e96ffc-06c1-4aa1-bc3d-ab9c0f604352",
"_parent_id": "0c0c3114-4f17-4d5c-b55e-9077be0f6bfe",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "22e9d082-4d9a-4ae1-9149-169d64c72255",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c3c2c428-3645-434f-a0cc-3762531620f5",
"_parent_id": "22d7d1f6-d38b-4ac0-91a1-591a4c2bbfcd",
"root_parent_id": "470e24c5-c39d-4b6d-ae2d-ba5ab335013d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "009687f7-bcca-42c0-bf12-d240e4f81b76",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1d9a32ac-bcf0-4570-925f-a7e54e1f5846",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9a2df63a-c4b1-4ecf-b490-f750567ed109",
"_parent_code": "sample string 6",
"sales_organization_id": "277dbb38-1c29-4ce3-9e05-f2eaaaeb546f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c1bf95c8-24b8-49bf-a8f4-64c097da4cc2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7bf195b4-3d3e-427f-8dca-aef1d200070a",
"db_currency_id": "2a10f75d-1e59-48da-a667-473bb7275fe8",
"db_language_id": "47968fb6-2154-45ca-a160-933331ef8208",
"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-05-01T06:29:44.3604621+00:00"
},
"modified_dateutc": "2026-05-01T06:29:44.3604621+00:00"
},
"equipment_model_id": "13730664-0ea2-4bd9-ac31-0647bf7b6b0a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2e46e873-4159-4dc2-9aa0-cef392b51e36",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "cf8ca218-d6b6-496b-9484-3fcccfa155fe",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3a8e9779-389d-49b2-9586-cd904f4cd4e5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "291f1c77-fc8a-4e5d-a7d7-55f27d499417",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c1bf95c8-24b8-49bf-a8f4-64c097da4cc2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7bf195b4-3d3e-427f-8dca-aef1d200070a",
"db_currency_id": "2a10f75d-1e59-48da-a667-473bb7275fe8",
"db_language_id": "47968fb6-2154-45ca-a160-933331ef8208",
"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-05-01T06:29:44.3604621+00:00"
},
"modified_dateutc": "2026-05-01T06:29:44.3604621+00:00"
},
"equipment_family_id": "b0731468-f26d-465c-b863-3a12480496b2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1d9a32ac-bcf0-4570-925f-a7e54e1f5846",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9a2df63a-c4b1-4ecf-b490-f750567ed109",
"_parent_code": "sample string 6",
"sales_organization_id": "277dbb38-1c29-4ce3-9e05-f2eaaaeb546f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c1bf95c8-24b8-49bf-a8f4-64c097da4cc2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7bf195b4-3d3e-427f-8dca-aef1d200070a",
"db_currency_id": "2a10f75d-1e59-48da-a667-473bb7275fe8",
"db_language_id": "47968fb6-2154-45ca-a160-933331ef8208",
"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-05-01T06:29:44.3604621+00:00"
},
"modified_dateutc": "2026-05-01T06:29:44.3604621+00:00"
},
"date_in_production_since": "2026-05-01T06:29:44.3604621+00:00",
"date_out_of_production_since": "2026-05-01T06:29:44.3604621+00:00",
"date_end_support": "2026-05-01T06:29:44.3604621+00:00",
"sales_organization_id": "668b398d-c85f-4b62-a8be-f77707fb3c6d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c1bf95c8-24b8-49bf-a8f4-64c097da4cc2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7bf195b4-3d3e-427f-8dca-aef1d200070a",
"db_currency_id": "2a10f75d-1e59-48da-a667-473bb7275fe8",
"db_language_id": "47968fb6-2154-45ca-a160-933331ef8208",
"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-05-01T06:29:44.3604621+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-05-01T06:29:44.3604621+00:00"
},
"project_status_id": "4cf1a50b-a1ab-4c04-b32a-b6845f22bc9f",
"project_status_code": "sample string 10",
"project_status": {
"id": "461eb77d-a527-4c14-9e48-394415c44fa2",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "df65c075-9fcb-41b8-9094-1488ff00d556",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c1bf95c8-24b8-49bf-a8f4-64c097da4cc2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7bf195b4-3d3e-427f-8dca-aef1d200070a",
"db_currency_id": "2a10f75d-1e59-48da-a667-473bb7275fe8",
"db_language_id": "47968fb6-2154-45ca-a160-933331ef8208",
"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-05-01T06:29:44.3604621+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-01T06:29:44.3604621+00:00"
},
"company_id": "52808835-438b-4da6-8409-33f8fdc38f1b",
"company_code": "sample string 12",
"db_address_id": "094121b9-7970-4503-b2d8-75019a5bef85",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8647ddb3-641f-47e9-abfe-81f27f7470fc",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b54ba06b-115d-4af2-b825-ec9a91dd56c8",
"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-05-01T06:29:44.3604621+00:00",
"date_create": "2026-05-01T06:29:44.3604621+00:00",
"date_update": "2026-05-01T06:29:44.3604621+00:00",
"updated_by_user_id": "fa0b918c-1b1b-4b5e-a044-b0f1d27cfcf5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-01T06:29:44.3604621+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-05-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-01T06:29:44.3604621+00:00",
"date_last_job": "2026-05-01T06:29:44.3604621+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-01T06:29:44.3604621+00:00",
"modified_dateutc": "2026-05-01T06:29:44.3604621+00:00",
"is_mobile_installation": true
},
"job_type_id": "77a02ec9-961b-4f9e-bce5-4e1230380391",
"job_type_code": "sample string 7",
"job_type": {
"id": "93e797d0-734e-4a16-a591-06ed89ed5d48",
"name": "sample string 2",
"sales_organization_id": "c74d452d-ecfe-45f9-affc-bcade04a221e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-01T06:29:44.3604621+00:00",
"code": "sample string 7"
},
"job_priority_id": "a1f3b370-e34d-455f-b687-77671e3728ff",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9091304c-d483-43a4-8c0b-3c1db092f9bf",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "73d4b4c4-1168-4711-9614-067e2ea13ef9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c1bf95c8-24b8-49bf-a8f4-64c097da4cc2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7bf195b4-3d3e-427f-8dca-aef1d200070a",
"db_currency_id": "2a10f75d-1e59-48da-a667-473bb7275fe8",
"db_language_id": "47968fb6-2154-45ca-a160-933331ef8208",
"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-05-01T06:29:44.3604621+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-01T06:29:44.3604621+00:00"
},
"job_status_id": "02e030c2-0474-4502-a8d0-5f988f3e5c90",
"job_status_code": "sample string 11",
"db_address_id": "20f5be46-8563-4579-80da-689cba7d89b7",
"contact_id": "c0549ce3-f154-4f7e-9cd3-53f5a5353ff9",
"requested_by_company_id": "47a5f4ba-efae-4227-b371-32e1bbef5e8d",
"requested_by_contact_id": "a6c8720e-711c-4d04-a09f-2b2dede6435e",
"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-05-01T06:29:44.3604621+00:00",
"due_date": "2026-05-01T06:29:44.3604621+00:00",
"date_create": "2026-05-01T06:29:44.3604621+00:00",
"date_update": "2026-05-01T06:29:44.3604621+00:00",
"date_closed": "2026-05-01T06:29:44.3604621+00:00",
"suggested_user_id": "b2f7984f-b0df-4f69-b155-a66653242e21",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e196411b-4ac8-4d5d-ab3b-3ad7c4be9f3a",
"db_language_id": "91b48745-feb4-43a4-bad9-ad59846f8265",
"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-05-01T06:29:44.3604621+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "de44e821-3e0b-45b1-8cf9-5e6af8d9ba3b",
"sales_organization": {
"id": "c1bf95c8-24b8-49bf-a8f4-64c097da4cc2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7bf195b4-3d3e-427f-8dca-aef1d200070a",
"db_currency_id": "2a10f75d-1e59-48da-a667-473bb7275fe8",
"db_language_id": "47968fb6-2154-45ca-a160-933331ef8208",
"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-05-01T06:29:44.3604621+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5cf8b3a3-b15a-4350-8025-a404e6e2f6af",
"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": "956a7232-fa34-433d-9e12-6fe35575b518",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-01T06:29:44.3604621+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d150d8cc-9080-49ab-a061-303acfb11df7"
},
"suggested_date_start": "2026-05-01T06:29:44.3604621+00:00",
"skill_id": "6140ed82-723d-4181-aef7-277ff819a79b",
"skill_code": "sample string 32",
"skill": {
"id": "3f703f9a-8031-4d22-8d8c-a20bd0f22297",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "232a8f96-4d10-4a65-b67f-b3976395d05f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c1bf95c8-24b8-49bf-a8f4-64c097da4cc2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7bf195b4-3d3e-427f-8dca-aef1d200070a",
"db_currency_id": "2a10f75d-1e59-48da-a667-473bb7275fe8",
"db_language_id": "47968fb6-2154-45ca-a160-933331ef8208",
"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-05-01T06:29:44.3604621+00:00"
},
"modified_dateutc": "2026-05-01T06:29:44.3604621+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "39c687cf-2832-4388-bbb5-2429fe3e4c7c",
"date_reported_by_company": "2026-05-01T06:29:44.3604621+00:00",
"id2": 36,
"company_id": "a4a7f1ac-65a0-4a88-a2f5-027c35f16d3b",
"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": "5bee00d6-f848-48a2-9b97-d622cd49d08b",
"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-05-01T06:29:44.3604621+00:00"
},
"work_instruction_details_id": "83a31772-d769-4455-8f57-3f8ee5557d16",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "eeca01b7-b227-4b64-be93-b7144478959c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "690c5c6b-6949-41b6-b518-3ff35cc0ba07",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-01T06:29:44.3604621+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": "ce45cf53-9aa9-4064-87e0-65db3787580d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-01T06:29:44.3604621+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.