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": "857deb83-5ffd-45d4-8211-d119dadc4766",
"jobs_id": "99555761-3601-42ea-b93b-dfc6994e6244",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f272cd27-94c7-4a78-8cd9-c597442d04e4",
"_parent_id": "d521be39-4257-4b27-a5e6-aa683d6fa763",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4cf7c48c-113d-4461-8042-d7925654824c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "423962b0-276f-422a-9d48-79e6e3b1c7cc",
"_parent_id": "64572b0a-ee42-4c3f-be38-278ce6a95dd7",
"root_parent_id": "abf15bdf-8e3f-45fd-b865-a740eb4604c6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "15541039-43fa-48c8-91ed-0dc171040762",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "52c30445-fca5-43e9-ae74-d39c11845d8e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2b6d281f-3a6c-440c-a066-83b8daf266bf",
"_parent_code": "sample string 6",
"sales_organization_id": "ab8dae53-d203-4699-872c-567d5005c431",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "085ee055-2e4a-4bf1-bf3c-b4ba443d6fd2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86624279-7d98-40c0-a495-666a7d30e9f9",
"db_currency_id": "a99c0821-9cc4-48c4-92eb-32cbc2fe4d50",
"db_language_id": "e463d318-c876-4116-93a1-30c2132c4a82",
"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-27T14:22:43.3021839+00:00"
},
"modified_dateutc": "2026-08-27T14:22:43.3021839+00:00"
},
"equipment_model_id": "c1e37c7e-4a1c-4a63-9801-bcf87b50529c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d7818e63-3d07-491a-aa6f-c123df9a2369",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "745c7d57-520d-4830-8cf8-b583ef57925d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1ee48d76-c334-4736-99c4-b55a039e1b9e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3da6a97e-03b5-46ef-8005-f5ee0913a3c0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "085ee055-2e4a-4bf1-bf3c-b4ba443d6fd2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86624279-7d98-40c0-a495-666a7d30e9f9",
"db_currency_id": "a99c0821-9cc4-48c4-92eb-32cbc2fe4d50",
"db_language_id": "e463d318-c876-4116-93a1-30c2132c4a82",
"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-27T14:22:43.3021839+00:00"
},
"modified_dateutc": "2026-08-27T14:22:43.3021839+00:00"
},
"equipment_family_id": "e17ef862-4f26-4e8c-a945-0b760a0cb5a3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "52c30445-fca5-43e9-ae74-d39c11845d8e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2b6d281f-3a6c-440c-a066-83b8daf266bf",
"_parent_code": "sample string 6",
"sales_organization_id": "ab8dae53-d203-4699-872c-567d5005c431",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "085ee055-2e4a-4bf1-bf3c-b4ba443d6fd2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86624279-7d98-40c0-a495-666a7d30e9f9",
"db_currency_id": "a99c0821-9cc4-48c4-92eb-32cbc2fe4d50",
"db_language_id": "e463d318-c876-4116-93a1-30c2132c4a82",
"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-27T14:22:43.3021839+00:00"
},
"modified_dateutc": "2026-08-27T14:22:43.3021839+00:00"
},
"date_in_production_since": "2026-08-27T14:22:43.3021839+00:00",
"date_out_of_production_since": "2026-08-27T14:22:43.3021839+00:00",
"date_end_support": "2026-08-27T14:22:43.3021839+00:00",
"sales_organization_id": "3574d1f4-511f-40be-a4e4-3e2ab9098119",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "085ee055-2e4a-4bf1-bf3c-b4ba443d6fd2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86624279-7d98-40c0-a495-666a7d30e9f9",
"db_currency_id": "a99c0821-9cc4-48c4-92eb-32cbc2fe4d50",
"db_language_id": "e463d318-c876-4116-93a1-30c2132c4a82",
"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-27T14:22:43.3021839+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-27T14:22:43.3021839+00:00"
},
"project_status_id": "f8eb0be6-dd19-4302-b287-26cd006c026d",
"project_status_code": "sample string 10",
"project_status": {
"id": "ac6b5fc5-67f3-4bf0-9e35-cdbc6268251f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "81512df2-2bfa-4b65-93fb-e4fd026c7712",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "085ee055-2e4a-4bf1-bf3c-b4ba443d6fd2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86624279-7d98-40c0-a495-666a7d30e9f9",
"db_currency_id": "a99c0821-9cc4-48c4-92eb-32cbc2fe4d50",
"db_language_id": "e463d318-c876-4116-93a1-30c2132c4a82",
"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-27T14:22:43.3021839+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-27T14:22:43.3021839+00:00"
},
"company_id": "718d6de4-c860-47c6-b01e-605826ea3269",
"company_code": "sample string 12",
"db_address_id": "d79ccbd5-2ef4-420a-87e7-0d81e1103870",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8976cc54-73fe-49de-bcb2-d0adef97796a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d9b64755-3140-4b0a-9b28-8aaac55e5ffd",
"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-27T14:22:43.3021839+00:00",
"date_create": "2026-08-27T14:22:43.3021839+00:00",
"date_update": "2026-08-27T14:22:43.3021839+00:00",
"updated_by_user_id": "65a0eb9f-9a26-4c59-bce3-52a50ac8893e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-27T14:22:43.3021839+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-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-27T14:22:43.3021839+00:00",
"date_last_job": "2026-08-27T14:22:43.3021839+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-27T14:22:43.3021839+00:00",
"modified_dateutc": "2026-08-27T14:22:43.3021839+00:00",
"is_mobile_installation": true
},
"job_type_id": "34a58c1b-0ff6-4a89-9c3f-ff6be2a5d02b",
"job_type_code": "sample string 7",
"job_type": {
"id": "aa7b0384-19a9-44f4-98cc-ce1bdd706ead",
"name": "sample string 2",
"sales_organization_id": "21706c47-7905-4fb6-944c-2270515b54b6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-27T14:22:43.3021839+00:00",
"code": "sample string 7"
},
"job_priority_id": "db552594-f163-4d89-98da-ad15b4a290a0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ae72f408-9013-4fcb-972f-7d4f4451cc88",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ae05d049-d210-409d-be30-bcf8a4724974",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "085ee055-2e4a-4bf1-bf3c-b4ba443d6fd2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86624279-7d98-40c0-a495-666a7d30e9f9",
"db_currency_id": "a99c0821-9cc4-48c4-92eb-32cbc2fe4d50",
"db_language_id": "e463d318-c876-4116-93a1-30c2132c4a82",
"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-27T14:22:43.3021839+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-27T14:22:43.3021839+00:00"
},
"job_status_id": "615371f2-5f71-4360-9538-0d4ed88a297a",
"job_status_code": "sample string 11",
"db_address_id": "eb000bd5-5401-48a0-a351-fe32572416b3",
"contact_id": "347af252-af2e-4b2e-9c89-802aaa14cd25",
"requested_by_company_id": "9e840433-ebc4-4543-96af-8f25badc7c7d",
"requested_by_contact_id": "d609e0cb-c1fd-4b83-a92d-8a2980e21109",
"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-27T14:22:43.3021839+00:00",
"due_date": "2026-08-27T14:22:43.3021839+00:00",
"date_create": "2026-08-27T14:22:43.3021839+00:00",
"date_update": "2026-08-27T14:22:43.3021839+00:00",
"date_closed": "2026-08-27T14:22:43.3021839+00:00",
"suggested_user_id": "b780660d-1ecd-44aa-b1ef-22c4aa1454a5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ec9afa9b-6254-4d14-bc9b-0d980008f8db",
"db_language_id": "530a6a4a-ddbf-40a4-8e63-4e44daddc861",
"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-27T14:22:43.3021839+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f3598757-30ac-4640-a27c-8d5b4c1285a5",
"sales_organization": {
"id": "085ee055-2e4a-4bf1-bf3c-b4ba443d6fd2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86624279-7d98-40c0-a495-666a7d30e9f9",
"db_currency_id": "a99c0821-9cc4-48c4-92eb-32cbc2fe4d50",
"db_language_id": "e463d318-c876-4116-93a1-30c2132c4a82",
"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-27T14:22:43.3021839+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c59462c1-4f6e-4bb1-9bd8-24ba0f5b3d5d",
"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": "d5014ead-8b80-48b5-a98c-4f9edaa01e18",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-27T14:22:43.3021839+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "78e98672-8178-424e-bb85-df9a7d309296"
},
"suggested_date_start": "2026-08-27T14:22:43.3021839+00:00",
"skill_id": "7729b8ae-26a9-4d20-a571-53147342b240",
"skill_code": "sample string 32",
"skill": {
"id": "f3492d37-3e28-4a2d-8e82-cc8e20daf7c1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "aab9ee23-e36e-4199-bbe5-3bd84bd20e71",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "085ee055-2e4a-4bf1-bf3c-b4ba443d6fd2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "86624279-7d98-40c0-a495-666a7d30e9f9",
"db_currency_id": "a99c0821-9cc4-48c4-92eb-32cbc2fe4d50",
"db_language_id": "e463d318-c876-4116-93a1-30c2132c4a82",
"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-27T14:22:43.3021839+00:00"
},
"modified_dateutc": "2026-08-27T14:22:43.3021839+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6de18c2f-a31c-43ad-8e30-534599d6e9e2",
"date_reported_by_company": "2026-08-27T14:22:43.3021839+00:00",
"id2": 36,
"company_id": "abde31b5-116f-4a14-9342-436d35477f81",
"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": "6d73317d-6164-4163-adbd-0fcc5892b99f",
"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-27T14:22:43.3021839+00:00"
},
"work_instruction_details_id": "bfe8ce82-b07b-4b36-a07a-cc19c4ca5120",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "364b288d-ac2b-47c4-b258-3ddfd14936c6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3150d573-aacb-4eb1-a792-ee086e5f8278",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-27T14:22:43.3021839+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": "8174d317-bfed-4491-a734-253f5196f21d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-27T14:22:43.3021839+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.