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": "acac81f7-c941-4343-9b1a-bcf1e4fc5416",
"jobs_id": "b26fa68d-a58e-4873-9a3b-99cae8719c58",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "01a65467-3402-4af7-bdb1-e2b19aa8d9c8",
"_parent_id": "fccdd16a-4e9c-4358-a161-124a13a98065",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "10150086-c57c-46f1-82bf-b800cd457bd5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e714bd6a-05b9-40d4-b2ee-7833d39d672c",
"_parent_id": "4bb14798-d8ee-41fa-944b-336a38c270b4",
"root_parent_id": "bbe60147-21d5-414b-997f-bd6008f0df88",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1ed7f9bb-7aa5-450c-b095-71f979ec4c62",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "217657a7-3eea-417a-850e-d940119e53be",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cbe26dea-716c-44f1-b87d-8b9bdfb2561b",
"_parent_code": "sample string 6",
"sales_organization_id": "d25d04b6-9d53-4ff7-8bac-8f0c94fa50fe",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b46c9509-1b05-48c5-9d0e-f0de1545cbb9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff91405-6d79-473f-9eec-ccc957ee4e4e",
"db_currency_id": "fa2f5a44-0857-42c4-9d6f-9d224922f1b9",
"db_language_id": "7e01e98d-08f0-47d2-b15e-9221e6cedb9a",
"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-13T00:55:39.2987477+00:00"
},
"modified_dateutc": "2026-07-13T00:55:39.2987477+00:00"
},
"equipment_model_id": "9f50754d-ab86-4486-bf24-79a9ffc879e4",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2e7b0470-c721-4411-82c0-a1bd322dd005",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6ec84f19-910d-4061-9df2-46ba7fb8b36e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "978f0fa7-a9d2-4f5a-a129-2844d8795f10",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ada2a8b0-adac-4a3c-82bb-602e3376db2f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b46c9509-1b05-48c5-9d0e-f0de1545cbb9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff91405-6d79-473f-9eec-ccc957ee4e4e",
"db_currency_id": "fa2f5a44-0857-42c4-9d6f-9d224922f1b9",
"db_language_id": "7e01e98d-08f0-47d2-b15e-9221e6cedb9a",
"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-13T00:55:39.2987477+00:00"
},
"modified_dateutc": "2026-07-13T00:55:39.2987477+00:00"
},
"equipment_family_id": "35672ab5-6e1f-473d-8b49-bc6e9b738110",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "217657a7-3eea-417a-850e-d940119e53be",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cbe26dea-716c-44f1-b87d-8b9bdfb2561b",
"_parent_code": "sample string 6",
"sales_organization_id": "d25d04b6-9d53-4ff7-8bac-8f0c94fa50fe",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b46c9509-1b05-48c5-9d0e-f0de1545cbb9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff91405-6d79-473f-9eec-ccc957ee4e4e",
"db_currency_id": "fa2f5a44-0857-42c4-9d6f-9d224922f1b9",
"db_language_id": "7e01e98d-08f0-47d2-b15e-9221e6cedb9a",
"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-13T00:55:39.2987477+00:00"
},
"modified_dateutc": "2026-07-13T00:55:39.2987477+00:00"
},
"date_in_production_since": "2026-07-13T00:55:39.2987477+00:00",
"date_out_of_production_since": "2026-07-13T00:55:39.2987477+00:00",
"date_end_support": "2026-07-13T00:55:39.2987477+00:00",
"sales_organization_id": "31f6d2a9-278e-4c05-aca2-220f3c3b509a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b46c9509-1b05-48c5-9d0e-f0de1545cbb9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff91405-6d79-473f-9eec-ccc957ee4e4e",
"db_currency_id": "fa2f5a44-0857-42c4-9d6f-9d224922f1b9",
"db_language_id": "7e01e98d-08f0-47d2-b15e-9221e6cedb9a",
"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-13T00:55:39.2987477+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-13T00:55:39.2987477+00:00"
},
"project_status_id": "c540b2bf-2950-488e-8c9e-5e76eb969745",
"project_status_code": "sample string 10",
"project_status": {
"id": "bc345060-6c56-4f84-ab03-db683789594c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "15764e4f-e5cf-4d0f-93a2-d9e358c4b96b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b46c9509-1b05-48c5-9d0e-f0de1545cbb9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff91405-6d79-473f-9eec-ccc957ee4e4e",
"db_currency_id": "fa2f5a44-0857-42c4-9d6f-9d224922f1b9",
"db_language_id": "7e01e98d-08f0-47d2-b15e-9221e6cedb9a",
"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-13T00:55:39.2987477+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-13T00:55:39.2987477+00:00"
},
"company_id": "132e8021-b89b-4172-bb6c-b8fa6f198dcc",
"company_code": "sample string 12",
"db_address_id": "b47fa7e6-7713-49ef-bee8-0e5558060f27",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "06bae280-9eff-464e-882f-418b4f2e34f3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "eb57369d-664b-4237-a1b7-3fb69b9e9d19",
"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-13T00:55:39.3143729+00:00",
"date_create": "2026-07-13T00:55:39.3143729+00:00",
"date_update": "2026-07-13T00:55:39.3143729+00:00",
"updated_by_user_id": "15a08455-b134-47c8-b59d-ec97c94ed96e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-13T00:55:39.3143729+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-13T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-13T00:55:39.3143729+00:00",
"date_last_job": "2026-07-13T00:55:39.3143729+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-13T00:55:39.3143729+00:00",
"modified_dateutc": "2026-07-13T00:55:39.3143729+00:00",
"is_mobile_installation": true
},
"job_type_id": "2386376d-fcfb-4896-9bf5-844c29ba1a45",
"job_type_code": "sample string 7",
"job_type": {
"id": "29867160-fc96-4215-8c57-e30f54a4c184",
"name": "sample string 2",
"sales_organization_id": "7a457397-8c0e-4b8b-8f85-d33a5ada9bd0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-13T00:55:39.3143729+00:00",
"code": "sample string 7"
},
"job_priority_id": "9daf5fb7-5b25-45ce-82a9-f0bea99cc948",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f84bba98-3ad8-4d36-a207-04ece676eeb6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9ec4f9df-b22c-4e47-8405-3c14af7dcee1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b46c9509-1b05-48c5-9d0e-f0de1545cbb9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff91405-6d79-473f-9eec-ccc957ee4e4e",
"db_currency_id": "fa2f5a44-0857-42c4-9d6f-9d224922f1b9",
"db_language_id": "7e01e98d-08f0-47d2-b15e-9221e6cedb9a",
"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-13T00:55:39.2987477+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-13T00:55:39.3143729+00:00"
},
"job_status_id": "a64ea972-2530-4076-bddc-73407b079702",
"job_status_code": "sample string 11",
"db_address_id": "38170af2-70d1-4ad1-9804-03af106cbb32",
"contact_id": "2fb9e76b-449f-4506-83d5-e8c0a36214b2",
"requested_by_company_id": "820aea7a-2c6c-42cf-a4bc-c4123bbb3c78",
"requested_by_contact_id": "444b200e-5170-4fff-8356-275b936e0ffc",
"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-13T00:55:39.3143729+00:00",
"due_date": "2026-07-13T00:55:39.3143729+00:00",
"date_create": "2026-07-13T00:55:39.3143729+00:00",
"date_update": "2026-07-13T00:55:39.3143729+00:00",
"date_closed": "2026-07-13T00:55:39.3143729+00:00",
"suggested_user_id": "d802b276-6f45-4d1a-9167-554a9cf83fc3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7f6e9132-de1a-4e20-8a2f-07fdba0756ae",
"db_language_id": "f763c9d4-5409-4020-9faa-c44afc0b72f4",
"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-13T00:55:39.3143729+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7aa57173-6e50-449e-83fc-2df8974aa546",
"sales_organization": {
"id": "b46c9509-1b05-48c5-9d0e-f0de1545cbb9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff91405-6d79-473f-9eec-ccc957ee4e4e",
"db_currency_id": "fa2f5a44-0857-42c4-9d6f-9d224922f1b9",
"db_language_id": "7e01e98d-08f0-47d2-b15e-9221e6cedb9a",
"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-13T00:55:39.2987477+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "51a8a554-95ea-4921-b2ef-1b6016f00fb3",
"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": "8886ac7e-6717-495f-af3f-073c0c7c5a51",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-13T00:55:39.3143729+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "14847779-310f-474e-b363-32426169b777"
},
"suggested_date_start": "2026-07-13T00:55:39.3143729+00:00",
"skill_id": "4b84a3f5-e82e-42b0-9cdc-939760191a27",
"skill_code": "sample string 32",
"skill": {
"id": "fd4d42e6-9ebc-46eb-b93c-dd7fce6e6d08",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6e24387b-23d4-47a7-be07-00c89e8299a0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b46c9509-1b05-48c5-9d0e-f0de1545cbb9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dff91405-6d79-473f-9eec-ccc957ee4e4e",
"db_currency_id": "fa2f5a44-0857-42c4-9d6f-9d224922f1b9",
"db_language_id": "7e01e98d-08f0-47d2-b15e-9221e6cedb9a",
"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-13T00:55:39.2987477+00:00"
},
"modified_dateutc": "2026-07-13T00:55:39.3143729+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "48572857-31fe-4ce2-8a98-3173f95b1b8c",
"date_reported_by_company": "2026-07-13T00:55:39.3143729+00:00",
"id2": 36,
"company_id": "cbb8b820-fa55-497e-afd8-9ceed47ce66f",
"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": "b93433ce-4f8e-49ae-82e9-e83430eecd76",
"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-13T00:55:39.3143729+00:00"
},
"work_instruction_details_id": "d0ac8723-7534-4bd4-9f6c-749308c21553",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9b113aec-28fa-4470-b1d0-8bebed08045b",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bdfea5e7-4634-4172-89bf-3df72602256f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-13T00:55:39.3143729+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": "1b9ca206-c5e3-4219-a396-3c7e8e57db36",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-13T00:55:39.3143729+00:00"
}