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": "bb20ffc5-83c1-4d5e-ae39-81fe162c07cc",
"jobs_id": "69ec5776-a9fd-4dc7-8a09-2ca9379ccca7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4b676e4e-4c61-4f4e-8b2e-bade4487631a",
"_parent_id": "a8f72e7e-36ba-48db-a9e9-127543134243",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "676f1be9-8fe2-4de2-bad6-0bf1678ed8f3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b227761f-f02f-47b7-9e4b-eed8d5ba3513",
"_parent_id": "5b9a87b7-d285-402b-b2a4-b5ceef063488",
"root_parent_id": "097d68c4-81d0-4681-b8f1-b59c05ccbdd4",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2c410b2c-9659-4b82-9393-d2a071ba0641",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "18051927-7c5b-413d-9baf-35d9867ee77f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d2875618-6c9c-4197-9738-9fd8e58850c9",
"_parent_code": "sample string 6",
"sales_organization_id": "9f7823af-89f8-4ada-a5ce-ae3934d06d3f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a4122bf2-34b3-4657-8037-2a3084b07f89",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a10a8441-d452-47bf-a735-63b895c2af0c",
"db_currency_id": "8e629224-d1ea-44f5-b9f7-8dd565dfdfd8",
"db_language_id": "3c4d6505-ddbb-4ed0-af71-75815075422e",
"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-07-16T01:15:10.421725+00:00"
},
"modified_dateutc": "2026-07-16T01:15:10.421725+00:00"
},
"equipment_model_id": "68b4c80a-a34a-4f5e-923e-28851ca3b259",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ce6b3543-43f2-483e-af5b-c999f60ca1ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "bd34f179-b569-4ed5-91d1-7d7ec0a5fa7d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "61c4e710-e12d-469b-b5a4-04a8bf8e06cc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d04a87e8-2d71-47ec-abe9-49850683c5e3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a4122bf2-34b3-4657-8037-2a3084b07f89",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a10a8441-d452-47bf-a735-63b895c2af0c",
"db_currency_id": "8e629224-d1ea-44f5-b9f7-8dd565dfdfd8",
"db_language_id": "3c4d6505-ddbb-4ed0-af71-75815075422e",
"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-07-16T01:15:10.421725+00:00"
},
"modified_dateutc": "2026-07-16T01:15:10.421725+00:00"
},
"equipment_family_id": "c2b24e9d-5968-4cdc-b4fa-0181bf9b8c45",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "18051927-7c5b-413d-9baf-35d9867ee77f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d2875618-6c9c-4197-9738-9fd8e58850c9",
"_parent_code": "sample string 6",
"sales_organization_id": "9f7823af-89f8-4ada-a5ce-ae3934d06d3f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a4122bf2-34b3-4657-8037-2a3084b07f89",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a10a8441-d452-47bf-a735-63b895c2af0c",
"db_currency_id": "8e629224-d1ea-44f5-b9f7-8dd565dfdfd8",
"db_language_id": "3c4d6505-ddbb-4ed0-af71-75815075422e",
"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-07-16T01:15:10.421725+00:00"
},
"modified_dateutc": "2026-07-16T01:15:10.421725+00:00"
},
"date_in_production_since": "2026-07-16T01:15:10.421725+00:00",
"date_out_of_production_since": "2026-07-16T01:15:10.421725+00:00",
"date_end_support": "2026-07-16T01:15:10.421725+00:00",
"sales_organization_id": "463555a2-f37b-4c17-8417-3e0fda504214",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a4122bf2-34b3-4657-8037-2a3084b07f89",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a10a8441-d452-47bf-a735-63b895c2af0c",
"db_currency_id": "8e629224-d1ea-44f5-b9f7-8dd565dfdfd8",
"db_language_id": "3c4d6505-ddbb-4ed0-af71-75815075422e",
"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-07-16T01:15:10.421725+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-07-16T01:15:10.421725+00:00"
},
"project_status_id": "89fd403f-1705-4818-9f4f-472f51215d13",
"project_status_code": "sample string 10",
"project_status": {
"id": "7a13af5c-9e44-4196-b960-3c2cae6fcff1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7d57a8ca-e5ba-474e-80ef-9c83b688c751",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a4122bf2-34b3-4657-8037-2a3084b07f89",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a10a8441-d452-47bf-a735-63b895c2af0c",
"db_currency_id": "8e629224-d1ea-44f5-b9f7-8dd565dfdfd8",
"db_language_id": "3c4d6505-ddbb-4ed0-af71-75815075422e",
"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-07-16T01:15:10.421725+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-16T01:15:10.421725+00:00"
},
"company_id": "a9936555-ebf5-4a9d-ae8b-38d0d6446250",
"company_code": "sample string 12",
"db_address_id": "58146950-1ea8-447f-a580-fb6d0e4ac3f4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3b9356fe-ad67-4b28-931b-b71047eac59f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7ff048b0-b1d2-444e-be9a-f1945cd3fe70",
"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-07-16T01:15:10.421725+00:00",
"date_create": "2026-07-16T01:15:10.421725+00:00",
"date_update": "2026-07-16T01:15:10.421725+00:00",
"updated_by_user_id": "946259be-2988-4b6f-b68e-bc290c2c8c7d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-16T01:15:10.421725+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-07-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-16T01:15:10.421725+00:00",
"date_last_job": "2026-07-16T01:15:10.421725+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-16T01:15:10.421725+00:00",
"modified_dateutc": "2026-07-16T01:15:10.421725+00:00",
"is_mobile_installation": true
},
"job_type_id": "75032e5e-33e4-44b7-8f2f-88730e355319",
"job_type_code": "sample string 7",
"job_type": {
"id": "277a6bb9-1ed7-4e3f-8622-990ef98b0643",
"name": "sample string 2",
"sales_organization_id": "7fc42cf7-4fc6-4bda-bdeb-8502b32d82a5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-16T01:15:10.421725+00:00",
"code": "sample string 7"
},
"job_priority_id": "1575f022-0951-47b8-8acd-a0dc730fc5aa",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "75ee7b15-ccea-451e-8f4c-3226482c7d50",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "db456186-263e-429e-ad8a-dcaac09abbac",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a4122bf2-34b3-4657-8037-2a3084b07f89",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a10a8441-d452-47bf-a735-63b895c2af0c",
"db_currency_id": "8e629224-d1ea-44f5-b9f7-8dd565dfdfd8",
"db_language_id": "3c4d6505-ddbb-4ed0-af71-75815075422e",
"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-07-16T01:15:10.421725+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-16T01:15:10.421725+00:00"
},
"job_status_id": "2b6dc7b5-a4f8-405c-902a-3a8efcb927fb",
"job_status_code": "sample string 11",
"db_address_id": "341069ae-962d-4150-8b1c-8035d6bfa2c4",
"contact_id": "5ddcacce-4dbd-4d4a-93da-1bde6fcf8274",
"requested_by_company_id": "2152586b-b948-40ce-984a-f37094272247",
"requested_by_contact_id": "5fe117bc-ec70-4af5-98bf-21491ace767b",
"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-07-16T01:15:10.421725+00:00",
"due_date": "2026-07-16T01:15:10.421725+00:00",
"date_create": "2026-07-16T01:15:10.421725+00:00",
"date_update": "2026-07-16T01:15:10.421725+00:00",
"date_closed": "2026-07-16T01:15:10.421725+00:00",
"suggested_user_id": "07173490-fa8d-4dcf-bb9f-7460858a804f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "502b67be-edab-4578-9ccb-cabdbb44a7f0",
"db_language_id": "14bfb042-5077-438b-860f-75c378ce210c",
"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-07-16T01:15:10.421725+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2baa86bf-320f-46b7-ae64-daca4c605568",
"sales_organization": {
"id": "a4122bf2-34b3-4657-8037-2a3084b07f89",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a10a8441-d452-47bf-a735-63b895c2af0c",
"db_currency_id": "8e629224-d1ea-44f5-b9f7-8dd565dfdfd8",
"db_language_id": "3c4d6505-ddbb-4ed0-af71-75815075422e",
"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-07-16T01:15:10.421725+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f1feefd2-e3ea-4e3c-9e13-78cb6f908075",
"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": "9db6f63c-ccdc-4e26-ab45-4ef64503b37b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-16T01:15:10.421725+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "84ec3000-bf6a-4a2b-855f-0c15367a3aa7"
},
"suggested_date_start": "2026-07-16T01:15:10.421725+00:00",
"skill_id": "72f87777-e034-4258-9715-530fc6866e67",
"skill_code": "sample string 32",
"skill": {
"id": "4388fd36-8aea-420b-b214-7a0cd27a17d5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8469672e-51ec-47be-b7e2-eaaac65e101e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a4122bf2-34b3-4657-8037-2a3084b07f89",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a10a8441-d452-47bf-a735-63b895c2af0c",
"db_currency_id": "8e629224-d1ea-44f5-b9f7-8dd565dfdfd8",
"db_language_id": "3c4d6505-ddbb-4ed0-af71-75815075422e",
"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-07-16T01:15:10.421725+00:00"
},
"modified_dateutc": "2026-07-16T01:15:10.421725+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "002b91a6-803d-4e8c-99ff-b589b62c0190",
"date_reported_by_company": "2026-07-16T01:15:10.421725+00:00",
"id2": 36,
"company_id": "9dbf2c96-d440-46fc-9c28-790014a3d31b",
"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": "02e0e0ba-7350-4f49-9356-b931d27906d3",
"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-07-16T01:15:10.421725+00:00"
},
"work_instruction_details_id": "f92e4c26-de25-4852-bd23-66f514574f7a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "66731528-2f29-491b-b2b6-3e5ac6b70cbb",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1f6b1a54-c7b0-4e31-93a6-1b9ad99a42f3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-16T01:15:10.421725+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": "00d0b684-881b-493b-a2eb-b0da4199ad9f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-16T01:15:10.421725+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.