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": "a2c306ed-9ac2-40b2-9d46-0a962930242b",
"jobs_id": "cd9e6965-ab82-43bd-a995-467927899e27",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "644850f8-2e08-4eb7-8708-3e7684ed3669",
"_parent_id": "c8adb800-3b50-4d46-bb45-489b7c45fa7f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b587cd3b-bee8-4b94-bb4d-ee04e49ed14b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "590ff1e5-cea9-4921-ae95-3a01e7ec2049",
"_parent_id": "6f502501-5eb2-4d18-bfa7-86acdf43f2dd",
"root_parent_id": "ec5c13ff-6a1e-439d-9a6a-fea9fc4b2266",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "18e698b4-688c-43ef-977e-89d7689bea63",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6b87559b-9462-4c84-9f9a-5c1e1114aa36",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d01079a6-bee9-4599-a20d-5ef9abab24a3",
"_parent_code": "sample string 6",
"sales_organization_id": "640c6d63-1ab9-44bd-ad52-4eef099ce4ea",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1cd81780-0a1a-470b-a48b-c33368fded97",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe809ab0-b655-431d-92ee-19a8149b575c",
"db_currency_id": "baaa2343-cdbd-49ad-8ce2-efb90b9b95f2",
"db_language_id": "462dab0f-bb21-47da-9983-f0ccc6b047c7",
"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": "2025-03-31T21:25:55.5329565+00:00"
},
"modified_dateutc": "2025-03-31T21:25:55.5329565+00:00"
},
"equipment_model_id": "54a66d80-ff38-441e-b800-f2dfffdf8b5c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "285fd5e9-efe9-488b-ada8-bb6626c1c865",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d6a499f2-a10c-47a8-85ef-3748a2bea2c8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d160c13e-5863-4ca5-936c-1d769986d9f4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "891e5f52-9a10-4977-868e-9904d2bbc8b3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1cd81780-0a1a-470b-a48b-c33368fded97",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe809ab0-b655-431d-92ee-19a8149b575c",
"db_currency_id": "baaa2343-cdbd-49ad-8ce2-efb90b9b95f2",
"db_language_id": "462dab0f-bb21-47da-9983-f0ccc6b047c7",
"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": "2025-03-31T21:25:55.5329565+00:00"
},
"modified_dateutc": "2025-03-31T21:25:55.5329565+00:00"
},
"equipment_family_id": "4d40471b-4537-4eef-92c1-395c93eb415b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6b87559b-9462-4c84-9f9a-5c1e1114aa36",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d01079a6-bee9-4599-a20d-5ef9abab24a3",
"_parent_code": "sample string 6",
"sales_organization_id": "640c6d63-1ab9-44bd-ad52-4eef099ce4ea",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1cd81780-0a1a-470b-a48b-c33368fded97",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe809ab0-b655-431d-92ee-19a8149b575c",
"db_currency_id": "baaa2343-cdbd-49ad-8ce2-efb90b9b95f2",
"db_language_id": "462dab0f-bb21-47da-9983-f0ccc6b047c7",
"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": "2025-03-31T21:25:55.5329565+00:00"
},
"modified_dateutc": "2025-03-31T21:25:55.5329565+00:00"
},
"date_in_production_since": "2025-03-31T21:25:55.5329565+00:00",
"date_out_of_production_since": "2025-03-31T21:25:55.5329565+00:00",
"date_end_support": "2025-03-31T21:25:55.5329565+00:00",
"sales_organization_id": "4b6597f5-3767-4c46-9b9f-e96a763bcaad",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1cd81780-0a1a-470b-a48b-c33368fded97",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe809ab0-b655-431d-92ee-19a8149b575c",
"db_currency_id": "baaa2343-cdbd-49ad-8ce2-efb90b9b95f2",
"db_language_id": "462dab0f-bb21-47da-9983-f0ccc6b047c7",
"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": "2025-03-31T21:25:55.5329565+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": "2025-03-31T21:25:55.5329565+00:00"
},
"project_status_id": "01308b3c-9516-4e2b-8d0d-73d57a4edbe5",
"project_status_code": "sample string 10",
"project_status": {
"id": "bf55f04a-069e-485e-b8c2-6505285d5db8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "479a75cc-f3d6-4eec-8c59-665bd701ecbb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1cd81780-0a1a-470b-a48b-c33368fded97",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe809ab0-b655-431d-92ee-19a8149b575c",
"db_currency_id": "baaa2343-cdbd-49ad-8ce2-efb90b9b95f2",
"db_language_id": "462dab0f-bb21-47da-9983-f0ccc6b047c7",
"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": "2025-03-31T21:25:55.5329565+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-03-31T21:25:55.5329565+00:00"
},
"company_id": "e0116d41-3437-4f4e-91f1-5e01773f85e4",
"company_code": "sample string 12",
"db_address_id": "1060d084-c076-4e8a-a512-827cc4aba7ae",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4ce4d083-2714-4512-82f5-9ef24ccc4109",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a10c54e5-efed-4909-a67b-6eaea5690f93",
"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": "2025-03-31T21:25:55.5329565+00:00",
"date_create": "2025-03-31T21:25:55.5329565+00:00",
"date_update": "2025-03-31T21:25:55.5329565+00:00",
"updated_by_user_id": "c0f96cac-1841-40c1-92a3-96fc6e1b4480",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-03-31T21:25:55.5329565+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": "2025-03-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-03-31T21:25:55.5329565+00:00",
"date_last_job": "2025-03-31T21:25:55.5329565+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-03-31T21:25:55.5329565+00:00",
"modified_dateutc": "2025-03-31T21:25:55.5329565+00:00",
"is_mobile_installation": true
},
"job_type_id": "71105e24-73d5-4764-8bc0-793cd02dcd22",
"job_type_code": "sample string 7",
"job_type": {
"id": "db8b23c0-8b77-4e89-90ee-28b72675f15c",
"name": "sample string 2",
"sales_organization_id": "42e7ac93-1f9f-452b-9b47-ec42215bb0d3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-03-31T21:25:55.5329565+00:00",
"code": "sample string 7"
},
"job_priority_id": "fb1dd7a1-0be2-4f27-b7f6-7752dbf673d9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1b06e1c9-f4e1-4134-b4f0-3cb1808917f0",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e3b8fca6-befa-4868-b795-876d2f52497b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1cd81780-0a1a-470b-a48b-c33368fded97",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe809ab0-b655-431d-92ee-19a8149b575c",
"db_currency_id": "baaa2343-cdbd-49ad-8ce2-efb90b9b95f2",
"db_language_id": "462dab0f-bb21-47da-9983-f0ccc6b047c7",
"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": "2025-03-31T21:25:55.5329565+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-03-31T21:25:55.5329565+00:00"
},
"job_status_id": "b28f5cbb-3b0a-4b00-8885-dd18ff6440e1",
"job_status_code": "sample string 11",
"db_address_id": "14711a77-af34-4fbf-85b0-982ff6e76734",
"contact_id": "8097924d-eaac-438d-bf76-b93aca2b4eb2",
"requested_by_company_id": "b8211d5b-a0fd-4918-9aec-1aeb8e016907",
"requested_by_contact_id": "60527973-8af1-4266-b28b-32ae951717de",
"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": "2025-03-31T21:25:55.5329565+00:00",
"due_date": "2025-03-31T21:25:55.5329565+00:00",
"date_create": "2025-03-31T21:25:55.5329565+00:00",
"date_update": "2025-03-31T21:25:55.5329565+00:00",
"date_closed": "2025-03-31T21:25:55.5329565+00:00",
"suggested_user_id": "e94c76d6-0969-41b8-ad19-5af1265fea51",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "98682297-7697-4dc1-a0a9-e3edb3f7f11a",
"db_language_id": "f61b44ea-e0c4-495a-84dc-1077d357603c",
"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": "2025-03-31T21:25:55.5329565+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "16d64725-e9b9-4784-be6d-a5724d96bd9b",
"sales_organization": {
"id": "1cd81780-0a1a-470b-a48b-c33368fded97",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe809ab0-b655-431d-92ee-19a8149b575c",
"db_currency_id": "baaa2343-cdbd-49ad-8ce2-efb90b9b95f2",
"db_language_id": "462dab0f-bb21-47da-9983-f0ccc6b047c7",
"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": "2025-03-31T21:25:55.5329565+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1ae1e5c9-f5b8-40d2-a814-79ca37cd4458",
"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": "31210dd0-958f-428d-bb29-e40a36224925",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-03-31T21:25:55.5329565+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "005e2178-74ae-49fd-bd99-cb47f0a6447d"
},
"suggested_date_start": "2025-03-31T21:25:55.5329565+00:00",
"skill_id": "89a9d404-a418-427f-9d8b-5df0f1fdfdd9",
"skill_code": "sample string 32",
"skill": {
"id": "b27b8fb9-97a6-4032-bd4e-f25b02d3f1d8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c2c10d87-e22e-4687-a927-d9c03124f184",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1cd81780-0a1a-470b-a48b-c33368fded97",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fe809ab0-b655-431d-92ee-19a8149b575c",
"db_currency_id": "baaa2343-cdbd-49ad-8ce2-efb90b9b95f2",
"db_language_id": "462dab0f-bb21-47da-9983-f0ccc6b047c7",
"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": "2025-03-31T21:25:55.5329565+00:00"
},
"modified_dateutc": "2025-03-31T21:25:55.5329565+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e37cefd5-4c5a-45dd-ae46-6d1b8ebad955",
"date_reported_by_company": "2025-03-31T21:25:55.5329565+00:00",
"id2": 36,
"company_id": "f93da831-f3b2-4860-a578-7b21b6857ef0",
"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": "6b4a192b-1ebb-4825-9700-61401346560f",
"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": "2025-03-31T21:25:55.5329565+00:00"
},
"work_instruction_details_id": "8b28abde-d616-497b-94ec-15bd3f4d5179",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "58b013fb-7d0d-4407-be3e-69e0f2747afa",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a29a90e6-60c2-4b9d-9228-6fd6031609a7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-03-31T21:25:55.5329565+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": "713e73e2-c248-461a-9ef0-c3a8b7e17bc9",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-03-31T21:25:55.5329565+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.