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": "fada8fdd-29fe-4d13-96e0-3cc2c7649e3a",
"jobs_id": "04178163-c092-4a16-ba5f-8eeba43abaad",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ffe101c5-5439-4b4e-8c1e-ef219f3c687c",
"_parent_id": "2db62ff3-b50d-4326-9e07-0f62b4fec681",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c938640b-2b7e-4255-b534-299f0a010855",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f3c0220f-91f4-4b42-b008-fe8991a5ee09",
"_parent_id": "0c27abe5-839a-4406-9624-f1346abbd453",
"root_parent_id": "5233ccc7-9ff3-4b37-8423-c50965cd4483",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0b3e5cac-8798-4cb6-a252-8e20543cc8c0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c014692a-d128-47f1-bde9-0c844af8e771",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "351686a1-daa3-4698-bee9-deb1829f1aea",
"_parent_code": "sample string 6",
"sales_organization_id": "bca933f5-a6aa-4956-9609-0e9b8b68268b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "786558ba-a219-4860-8ebf-36e034966e08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ba354c9-e396-424b-90fa-ab8ead2c0e35",
"db_currency_id": "3517cb69-b24e-4741-9679-a26cbbc4ccc0",
"db_language_id": "fe7d2917-5673-4ea8-a0d7-a8cd38a5af95",
"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-12-05T01:28:19.074397+00:00"
},
"modified_dateutc": "2025-12-05T01:28:19.074397+00:00"
},
"equipment_model_id": "405c7abf-263e-4424-ac85-a32392cfcb67",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ebd7cf99-4910-4f34-97a7-41556e402a12",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "08dcc2e7-fdd7-4c6c-8eb4-894bcbf8ea46",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b1336170-0039-4443-ad29-a7ee76508f37",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6e492377-33ef-4de5-9fcc-d2d90057ea8a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "786558ba-a219-4860-8ebf-36e034966e08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ba354c9-e396-424b-90fa-ab8ead2c0e35",
"db_currency_id": "3517cb69-b24e-4741-9679-a26cbbc4ccc0",
"db_language_id": "fe7d2917-5673-4ea8-a0d7-a8cd38a5af95",
"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-12-05T01:28:19.074397+00:00"
},
"modified_dateutc": "2025-12-05T01:28:19.074397+00:00"
},
"equipment_family_id": "1f384a06-0152-4e1e-9400-44345b64b787",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c014692a-d128-47f1-bde9-0c844af8e771",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "351686a1-daa3-4698-bee9-deb1829f1aea",
"_parent_code": "sample string 6",
"sales_organization_id": "bca933f5-a6aa-4956-9609-0e9b8b68268b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "786558ba-a219-4860-8ebf-36e034966e08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ba354c9-e396-424b-90fa-ab8ead2c0e35",
"db_currency_id": "3517cb69-b24e-4741-9679-a26cbbc4ccc0",
"db_language_id": "fe7d2917-5673-4ea8-a0d7-a8cd38a5af95",
"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-12-05T01:28:19.074397+00:00"
},
"modified_dateutc": "2025-12-05T01:28:19.074397+00:00"
},
"date_in_production_since": "2025-12-05T01:28:19.074397+00:00",
"date_out_of_production_since": "2025-12-05T01:28:19.074397+00:00",
"date_end_support": "2025-12-05T01:28:19.074397+00:00",
"sales_organization_id": "27677d90-9eb1-4137-ade8-9b7fdec6bd1f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "786558ba-a219-4860-8ebf-36e034966e08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ba354c9-e396-424b-90fa-ab8ead2c0e35",
"db_currency_id": "3517cb69-b24e-4741-9679-a26cbbc4ccc0",
"db_language_id": "fe7d2917-5673-4ea8-a0d7-a8cd38a5af95",
"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-12-05T01:28:19.074397+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-12-05T01:28:19.074397+00:00"
},
"project_status_id": "693983a7-7565-4142-a9c6-e2754e777a54",
"project_status_code": "sample string 10",
"project_status": {
"id": "71335491-00fc-4804-92d4-1ca6c884099f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f31bc26b-505b-42e8-9fea-865b12ea025c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "786558ba-a219-4860-8ebf-36e034966e08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ba354c9-e396-424b-90fa-ab8ead2c0e35",
"db_currency_id": "3517cb69-b24e-4741-9679-a26cbbc4ccc0",
"db_language_id": "fe7d2917-5673-4ea8-a0d7-a8cd38a5af95",
"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-12-05T01:28:19.074397+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-05T01:28:19.074397+00:00"
},
"company_id": "ac34e375-6739-49b8-9e9f-c171fb6bcd93",
"company_code": "sample string 12",
"db_address_id": "03580de7-6857-4753-bfba-9868fab77abd",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "221ba81f-b1f0-4c28-8e56-0ae23904bfb8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9ce1093b-65ef-4185-b074-d6a7a73cd307",
"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-12-05T01:28:19.074397+00:00",
"date_create": "2025-12-05T01:28:19.074397+00:00",
"date_update": "2025-12-05T01:28:19.074397+00:00",
"updated_by_user_id": "61b73f11-7edc-4f29-a276-0e672a6e7063",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-05T01:28:19.074397+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-12-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-05T01:28:19.074397+00:00",
"date_last_job": "2025-12-05T01:28:19.074397+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-05T01:28:19.074397+00:00",
"modified_dateutc": "2025-12-05T01:28:19.074397+00:00",
"is_mobile_installation": true
},
"job_type_id": "b65b3174-b552-4e97-a6ad-6726af023678",
"job_type_code": "sample string 7",
"job_type": {
"id": "85d0181e-79bf-40d6-92da-2d9a1ce1017f",
"name": "sample string 2",
"sales_organization_id": "7d937169-e66b-470c-b53e-0cb5aec4e796",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-05T01:28:19.074397+00:00",
"code": "sample string 7"
},
"job_priority_id": "579eada5-808f-439b-8822-4c65e7910d8f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7b9fe647-1bc9-4b18-9a38-b7707a913523",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f6a4ee48-15ab-4804-835f-2c3a0282a9f6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "786558ba-a219-4860-8ebf-36e034966e08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ba354c9-e396-424b-90fa-ab8ead2c0e35",
"db_currency_id": "3517cb69-b24e-4741-9679-a26cbbc4ccc0",
"db_language_id": "fe7d2917-5673-4ea8-a0d7-a8cd38a5af95",
"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-12-05T01:28:19.074397+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-05T01:28:19.074397+00:00"
},
"job_status_id": "3b208dff-44bc-4890-ad14-420a168c1932",
"job_status_code": "sample string 11",
"db_address_id": "4c2711eb-9095-407e-8b9f-663d9bc9bf58",
"contact_id": "452931ed-233c-479d-a436-1a3bcaa8d4c7",
"requested_by_company_id": "25e0452f-e681-4058-8dd7-1c09a5ba265b",
"requested_by_contact_id": "7fb71a52-e898-42fa-8692-66b347ef41c8",
"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-12-05T01:28:19.074397+00:00",
"due_date": "2025-12-05T01:28:19.074397+00:00",
"date_create": "2025-12-05T01:28:19.074397+00:00",
"date_update": "2025-12-05T01:28:19.074397+00:00",
"date_closed": "2025-12-05T01:28:19.074397+00:00",
"suggested_user_id": "e9ca64ec-a4ad-4082-9945-eefcc769d832",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "de381e58-bd0d-47de-90db-ccae03ed60f3",
"db_language_id": "9e2bb5eb-e07c-48c5-a972-2b3da2585cf3",
"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-12-05T01:28:19.074397+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6a9a2607-ca2f-4e8d-a953-d2c34cef25eb",
"sales_organization": {
"id": "786558ba-a219-4860-8ebf-36e034966e08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ba354c9-e396-424b-90fa-ab8ead2c0e35",
"db_currency_id": "3517cb69-b24e-4741-9679-a26cbbc4ccc0",
"db_language_id": "fe7d2917-5673-4ea8-a0d7-a8cd38a5af95",
"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-12-05T01:28:19.074397+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "cb25533a-3237-466d-b5cf-5c742d808fe2",
"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": "95bea0a4-5a9a-4697-b004-ca36b657a13f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-05T01:28:19.074397+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b25b331e-bb63-44ab-8633-ee8bf2cbc0a0"
},
"suggested_date_start": "2025-12-05T01:28:19.074397+00:00",
"skill_id": "65f0eb35-9238-41dd-9b7b-5b2c85a3c7a8",
"skill_code": "sample string 32",
"skill": {
"id": "c46fd6be-5c8d-493c-b8a3-35672cfaad7e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ff582486-96b4-4fc2-aa85-32b1d69c91ad",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "786558ba-a219-4860-8ebf-36e034966e08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2ba354c9-e396-424b-90fa-ab8ead2c0e35",
"db_currency_id": "3517cb69-b24e-4741-9679-a26cbbc4ccc0",
"db_language_id": "fe7d2917-5673-4ea8-a0d7-a8cd38a5af95",
"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-12-05T01:28:19.074397+00:00"
},
"modified_dateutc": "2025-12-05T01:28:19.074397+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "86cbbc78-50f0-4d62-9c70-6df39b2cffe4",
"date_reported_by_company": "2025-12-05T01:28:19.074397+00:00",
"id2": 36,
"company_id": "59f64661-6d5f-461c-9850-7c5333bbe8f3",
"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": "49eb491a-c158-4b10-8e33-03c1036a2349",
"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-12-05T01:28:19.074397+00:00"
},
"work_instruction_details_id": "d32f80ae-1c58-4b93-bacf-c9e61c97df2a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3dcbaab9-f820-4ec3-9b8e-f00d1b7798ee",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bf6e1b91-ced7-486d-b27f-996399e82d28",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-05T01:28:19.074397+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": "98aacc3f-f697-448e-a2cf-efddd405fd6d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-05T01:28:19.0900196+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.