Retrieves 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 :
None.
Response Information
Resource Description :
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 |
Response Formats
application/json, text/json
Sample:
{
"id": "615a0a83-2a3c-4837-b4c7-b59f5e7a3535",
"jobs_id": "85923811-7c56-423e-b7db-f089b8379276",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ef3db9a8-9972-4f0f-8a90-e7e2cc44d9d5",
"_parent_id": "7ec44fda-1a97-49b4-9a8b-c4f8f36fc95e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3e24bbb4-e38c-427a-a660-9126cc319520",
"project_reference_back_office": "sample string 5",
"project": {
"id": "be7b9f32-db47-4abc-b889-d007c635ccbe",
"_parent_id": "f9085529-b80a-4e98-ab25-457160f4d1e7",
"root_parent_id": "8cef2097-fd58-4757-8c52-fdf5b7889218",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "071bd4cb-eb61-46b0-9826-8d73cb4176ab",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fcb5eea5-0039-4046-abef-0fdf13f78349",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d6b2e1e4-aacb-4e41-8ae4-1ba65be023ea",
"_parent_code": "sample string 6",
"sales_organization_id": "ce94060c-5d6a-4247-b0cc-3fb7b532fde0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "777796e8-b11d-4642-8127-1f674bcbee6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "18abda39-a40d-4eec-ab6e-f1c1d8903962",
"db_currency_id": "bf122357-1905-4248-9b4f-d919f65cefb4",
"db_language_id": "4afc40a1-35b1-4820-a45c-c68642ff739b",
"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-05-29T09:21:03.3823126+00:00"
},
"modified_dateutc": "2025-05-29T09:21:03.3823126+00:00"
},
"equipment_model_id": "25b9d8d5-b6e1-4fd9-af29-200c4cf40e82",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f8c76858-ca29-4d46-bd76-e8f5a4b4461d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "bf302097-fd5e-45d7-91bb-1f98adea0ca3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5c0bcefa-9536-4984-a94b-e144143e92fe",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2f73ee24-4476-4cbe-b208-87a24c724dd0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "777796e8-b11d-4642-8127-1f674bcbee6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "18abda39-a40d-4eec-ab6e-f1c1d8903962",
"db_currency_id": "bf122357-1905-4248-9b4f-d919f65cefb4",
"db_language_id": "4afc40a1-35b1-4820-a45c-c68642ff739b",
"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-05-29T09:21:03.3823126+00:00"
},
"modified_dateutc": "2025-05-29T09:21:03.3823126+00:00"
},
"equipment_family_id": "f7350e7e-eba6-41e0-a187-1a24e4fe54c5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fcb5eea5-0039-4046-abef-0fdf13f78349",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d6b2e1e4-aacb-4e41-8ae4-1ba65be023ea",
"_parent_code": "sample string 6",
"sales_organization_id": "ce94060c-5d6a-4247-b0cc-3fb7b532fde0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "777796e8-b11d-4642-8127-1f674bcbee6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "18abda39-a40d-4eec-ab6e-f1c1d8903962",
"db_currency_id": "bf122357-1905-4248-9b4f-d919f65cefb4",
"db_language_id": "4afc40a1-35b1-4820-a45c-c68642ff739b",
"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-05-29T09:21:03.3823126+00:00"
},
"modified_dateutc": "2025-05-29T09:21:03.3823126+00:00"
},
"date_in_production_since": "2025-05-29T09:21:03.3823126+00:00",
"date_out_of_production_since": "2025-05-29T09:21:03.3823126+00:00",
"date_end_support": "2025-05-29T09:21:03.3823126+00:00",
"sales_organization_id": "02bfe6a0-2c4e-4449-8818-9f4f3dcf1939",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "777796e8-b11d-4642-8127-1f674bcbee6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "18abda39-a40d-4eec-ab6e-f1c1d8903962",
"db_currency_id": "bf122357-1905-4248-9b4f-d919f65cefb4",
"db_language_id": "4afc40a1-35b1-4820-a45c-c68642ff739b",
"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-05-29T09:21:03.3823126+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-05-29T09:21:03.3823126+00:00"
},
"project_status_id": "f1b50d43-fcb3-4673-ba02-60488ecdfacb",
"project_status_code": "sample string 10",
"project_status": {
"id": "44b09730-7400-4405-b23e-10ff7e0f7aff",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e1aabf25-0a23-433f-90ae-bf95d3b3118d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "777796e8-b11d-4642-8127-1f674bcbee6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "18abda39-a40d-4eec-ab6e-f1c1d8903962",
"db_currency_id": "bf122357-1905-4248-9b4f-d919f65cefb4",
"db_language_id": "4afc40a1-35b1-4820-a45c-c68642ff739b",
"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-05-29T09:21:03.3823126+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-29T09:21:03.3823126+00:00"
},
"company_id": "cf685f06-e56d-43d4-a61e-92bc99820d78",
"company_code": "sample string 12",
"db_address_id": "0aff78d4-bf10-43ca-82ca-f825930c8c1d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f1a1e727-caed-4564-9962-193e7e11300a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d3521404-ec64-48df-a236-ab0de8b83339",
"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-05-29T09:21:03.3823126+00:00",
"date_create": "2025-05-29T09:21:03.3823126+00:00",
"date_update": "2025-05-29T09:21:03.3823126+00:00",
"updated_by_user_id": "fec8f78f-27c2-4c50-a804-a41159aa35d2",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-05-29T09:21:03.3823126+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-05-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-05-29T09:21:03.3823126+00:00",
"date_last_job": "2025-05-29T09:21:03.3823126+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-05-29T09:21:03.3823126+00:00",
"modified_dateutc": "2025-05-29T09:21:03.3823126+00:00",
"is_mobile_installation": true
},
"job_type_id": "57089089-416d-42f1-8949-406346f12d8b",
"job_type_code": "sample string 7",
"job_type": {
"id": "b0ebb375-f56d-407a-885c-835ba3f1a15c",
"name": "sample string 2",
"sales_organization_id": "05c3be0e-1e15-4612-97e5-70c41c986c54",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-05-29T09:21:03.3823126+00:00",
"code": "sample string 7"
},
"job_priority_id": "cac6946a-76aa-4765-be42-c8cb6aa51886",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f85106d6-efa7-4305-b2aa-4a925149f1cf",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7db6d78c-c455-47ad-96b3-561fd289e6f9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "777796e8-b11d-4642-8127-1f674bcbee6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "18abda39-a40d-4eec-ab6e-f1c1d8903962",
"db_currency_id": "bf122357-1905-4248-9b4f-d919f65cefb4",
"db_language_id": "4afc40a1-35b1-4820-a45c-c68642ff739b",
"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-05-29T09:21:03.3823126+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-29T09:21:03.3823126+00:00"
},
"job_status_id": "0265ca3d-4634-4940-b418-e2f8559db760",
"job_status_code": "sample string 11",
"db_address_id": "843ab00d-93f0-4971-9c4c-48c55622cd3b",
"contact_id": "ef24664c-452d-474c-b040-a9bbacaca633",
"requested_by_company_id": "d3377a5d-f051-407d-b666-bc33b170dd56",
"requested_by_contact_id": "997de227-e4d4-4ded-9ffa-818fe425bb15",
"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-05-29T09:21:03.3823126+00:00",
"due_date": "2025-05-29T09:21:03.3823126+00:00",
"date_create": "2025-05-29T09:21:03.3823126+00:00",
"date_update": "2025-05-29T09:21:03.3823126+00:00",
"date_closed": "2025-05-29T09:21:03.3823126+00:00",
"suggested_user_id": "bc683873-b624-4878-965a-f195b2aa3141",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "029ea94e-dfb6-498b-b778-74b0dbf1ba54",
"db_language_id": "35d05759-f05c-4f12-b999-2aae26411ca8",
"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-05-29T09:21:03.3823126+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f44d92b2-a9e2-432e-b088-285d644e4ccd",
"sales_organization": {
"id": "777796e8-b11d-4642-8127-1f674bcbee6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "18abda39-a40d-4eec-ab6e-f1c1d8903962",
"db_currency_id": "bf122357-1905-4248-9b4f-d919f65cefb4",
"db_language_id": "4afc40a1-35b1-4820-a45c-c68642ff739b",
"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-05-29T09:21:03.3823126+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ba72aed9-e228-4059-be30-5f8a8a041205",
"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": "806e62c1-400c-458d-a414-289cec8c484c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-05-29T09:21:03.3823126+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6ec6f934-cda0-4956-9507-4772e5793403"
},
"suggested_date_start": "2025-05-29T09:21:03.3823126+00:00",
"skill_id": "cc58da99-aff2-44c6-9744-d2cb13c9f496",
"skill_code": "sample string 32",
"skill": {
"id": "9e792296-bcb0-4864-9f88-8c53dc5db849",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a036ef13-ee96-4cfa-9b1e-b57bb894ba31",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "777796e8-b11d-4642-8127-1f674bcbee6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "18abda39-a40d-4eec-ab6e-f1c1d8903962",
"db_currency_id": "bf122357-1905-4248-9b4f-d919f65cefb4",
"db_language_id": "4afc40a1-35b1-4820-a45c-c68642ff739b",
"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-05-29T09:21:03.3823126+00:00"
},
"modified_dateutc": "2025-05-29T09:21:03.3823126+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6584bae5-00de-46c8-ba83-909b570a3200",
"date_reported_by_company": "2025-05-29T09:21:03.3823126+00:00",
"id2": 36,
"company_id": "91e55205-d6b8-40ca-a9ee-367420676fc5",
"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": "aa45a51f-9996-4916-b42d-ede7c7ee0605",
"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-05-29T09:21:03.3823126+00:00"
},
"work_instruction_details_id": "88c68dc0-5792-4263-8f23-49984c193e55",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2f0a7d89-72d4-4ae3-b0c3-4a9b7ef914c5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "823c6ef4-adb7-420f-b4ee-bec69fd694c2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-05-29T09:21:03.3823126+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": "8daf7269-f7ba-4049-956d-6dfa0d27f589",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-05-29T09:21:03.3823126+00:00"
}