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": "e73e1a12-c4d6-464c-b133-1b4c6dd4a5d4",
"jobs_id": "81f77534-43a5-4600-9121-afddd6d9739f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "cfb8ef92-b2df-45c0-bc37-fea18b9a6c35",
"_parent_id": "1552fc0c-b7ca-47e3-a359-8bec9335b05b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ee306f7d-1837-4389-bd7a-9ecfcfc98a47",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c68f0195-d221-4c05-a744-8e6df4a0b9e0",
"_parent_id": "ddf5402a-ed12-4923-85a8-4f657058f764",
"root_parent_id": "09de405d-56b2-4dc0-bd6e-396d1202811e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a0d17465-357a-45ca-a77f-2b069f22bd86",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4bdc1891-8c5a-4eec-9153-69854970af8f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bc4fe46e-ee0a-4c88-8b0e-0130f91af9df",
"_parent_code": "sample string 6",
"sales_organization_id": "19aaeff7-9913-450f-ae4b-39ddfbac89db",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "13a66e6d-f08c-4060-aa98-f462989ff562",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13b842a8-8371-43d8-bd80-68d5670ad18c",
"db_currency_id": "18854873-de38-42ad-bf9e-5b48a47e1c9b",
"db_language_id": "e03ceb7c-15f3-45b9-bb1e-cf9dae9e10cf",
"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-03-06T07:48:57.0650887+00:00"
},
"modified_dateutc": "2026-03-06T07:48:57.0650887+00:00"
},
"equipment_model_id": "4b59b211-b54e-4cc4-bdfb-3e47c904ee97",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "54e0c095-5db2-436e-a16a-162a60eec2fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9680220e-4191-4c10-a26b-ce199ba99ff4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1ed4d5d9-162f-4164-a6c0-55c8e2d70395",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a0a358c0-51f9-41f9-9062-b78fc52a839a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "13a66e6d-f08c-4060-aa98-f462989ff562",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13b842a8-8371-43d8-bd80-68d5670ad18c",
"db_currency_id": "18854873-de38-42ad-bf9e-5b48a47e1c9b",
"db_language_id": "e03ceb7c-15f3-45b9-bb1e-cf9dae9e10cf",
"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-03-06T07:48:57.0650887+00:00"
},
"modified_dateutc": "2026-03-06T07:48:57.0650887+00:00"
},
"equipment_family_id": "97cecda2-87fa-4bdd-a676-0a0f8fcd9992",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4bdc1891-8c5a-4eec-9153-69854970af8f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bc4fe46e-ee0a-4c88-8b0e-0130f91af9df",
"_parent_code": "sample string 6",
"sales_organization_id": "19aaeff7-9913-450f-ae4b-39ddfbac89db",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "13a66e6d-f08c-4060-aa98-f462989ff562",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13b842a8-8371-43d8-bd80-68d5670ad18c",
"db_currency_id": "18854873-de38-42ad-bf9e-5b48a47e1c9b",
"db_language_id": "e03ceb7c-15f3-45b9-bb1e-cf9dae9e10cf",
"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-03-06T07:48:57.0650887+00:00"
},
"modified_dateutc": "2026-03-06T07:48:57.0650887+00:00"
},
"date_in_production_since": "2026-03-06T07:48:57.0650887+00:00",
"date_out_of_production_since": "2026-03-06T07:48:57.0650887+00:00",
"date_end_support": "2026-03-06T07:48:57.0650887+00:00",
"sales_organization_id": "1518a8a2-b0eb-4953-9c42-bdf2aa377db1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "13a66e6d-f08c-4060-aa98-f462989ff562",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13b842a8-8371-43d8-bd80-68d5670ad18c",
"db_currency_id": "18854873-de38-42ad-bf9e-5b48a47e1c9b",
"db_language_id": "e03ceb7c-15f3-45b9-bb1e-cf9dae9e10cf",
"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-03-06T07:48:57.0650887+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-03-06T07:48:57.0650887+00:00"
},
"project_status_id": "2a448a7c-968a-421a-a390-9f4303c9c718",
"project_status_code": "sample string 10",
"project_status": {
"id": "ee8e306d-269b-4ffe-adae-5d65b20e8873",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "fb48f9f7-073e-4dcb-bb1b-437b136d887f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "13a66e6d-f08c-4060-aa98-f462989ff562",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13b842a8-8371-43d8-bd80-68d5670ad18c",
"db_currency_id": "18854873-de38-42ad-bf9e-5b48a47e1c9b",
"db_language_id": "e03ceb7c-15f3-45b9-bb1e-cf9dae9e10cf",
"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-03-06T07:48:57.0650887+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-06T07:48:57.0650887+00:00"
},
"company_id": "27f12fc8-2544-4a1d-9781-aa07b8464387",
"company_code": "sample string 12",
"db_address_id": "59c4c16c-9f0e-4633-865a-94b8b23e3577",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d2b39fc6-222a-48e3-9bff-852e84a50f0a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0c283f64-7944-4ae6-9263-79fadb71778d",
"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-03-06T07:48:57.0650887+00:00",
"date_create": "2026-03-06T07:48:57.0650887+00:00",
"date_update": "2026-03-06T07:48:57.0650887+00:00",
"updated_by_user_id": "30b7e244-53c0-4a6e-86a5-fdc9e4e7be9c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-06T07:48:57.0650887+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-03-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-06T07:48:57.0650887+00:00",
"date_last_job": "2026-03-06T07:48:57.0650887+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-06T07:48:57.0650887+00:00",
"modified_dateutc": "2026-03-06T07:48:57.0650887+00:00",
"is_mobile_installation": true
},
"job_type_id": "94f72326-a3c9-4ba0-96b6-7a818c88d033",
"job_type_code": "sample string 7",
"job_type": {
"id": "40fe77ab-8d5b-435e-bb7e-9197e0a2637a",
"name": "sample string 2",
"sales_organization_id": "68ab1ad0-96ca-4f4f-be5f-f1fd7b0d6536",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-06T07:48:57.0650887+00:00",
"code": "sample string 7"
},
"job_priority_id": "8c77aa62-0bff-4a66-9e29-c4f9be07b460",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "017af7a1-1740-47d8-86c0-a1b27abf406d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "2d30eec6-01db-4e41-b3df-5c95ee05a01e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "13a66e6d-f08c-4060-aa98-f462989ff562",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13b842a8-8371-43d8-bd80-68d5670ad18c",
"db_currency_id": "18854873-de38-42ad-bf9e-5b48a47e1c9b",
"db_language_id": "e03ceb7c-15f3-45b9-bb1e-cf9dae9e10cf",
"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-03-06T07:48:57.0650887+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-06T07:48:57.0650887+00:00"
},
"job_status_id": "ccd076ee-6fb0-4998-83e4-a3847129bb5e",
"job_status_code": "sample string 11",
"db_address_id": "2b4ff38e-58b5-416c-8b01-a77918df506d",
"contact_id": "3999a5b3-e8ad-4caa-b652-8e80896ceb9a",
"requested_by_company_id": "301c96bc-e2f1-43df-99c9-041d22975e87",
"requested_by_contact_id": "1f4f3d38-91f3-49be-a4cf-d8541f7ebc32",
"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-03-06T07:48:57.0650887+00:00",
"due_date": "2026-03-06T07:48:57.0650887+00:00",
"date_create": "2026-03-06T07:48:57.0650887+00:00",
"date_update": "2026-03-06T07:48:57.0650887+00:00",
"date_closed": "2026-03-06T07:48:57.0650887+00:00",
"suggested_user_id": "98bdb874-c171-40a0-8837-b72031f96846",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "07ed73f8-084d-4979-85d7-b341bbce1845",
"db_language_id": "08d9bd25-22eb-42ae-8093-5268e58e7f3c",
"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-03-06T07:48:57.0807137+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "44082657-235c-4cfe-ac57-e3a37174b83a",
"sales_organization": {
"id": "13a66e6d-f08c-4060-aa98-f462989ff562",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13b842a8-8371-43d8-bd80-68d5670ad18c",
"db_currency_id": "18854873-de38-42ad-bf9e-5b48a47e1c9b",
"db_language_id": "e03ceb7c-15f3-45b9-bb1e-cf9dae9e10cf",
"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-03-06T07:48:57.0650887+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "61c597bb-2eec-4de5-b6a9-92b216870962",
"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": "9dcfe26d-ceae-4dfc-8635-b0e9ae691cce",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-06T07:48:57.0807137+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "521ded35-a59b-4409-975d-e5a85a21af01"
},
"suggested_date_start": "2026-03-06T07:48:57.0807137+00:00",
"skill_id": "59ecd35f-b23f-470d-89bc-45a9cccf3a37",
"skill_code": "sample string 32",
"skill": {
"id": "c962d729-54f5-4d47-a998-b1d585e19d76",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5f06dbd1-4e0b-4711-bc8d-32db95561ed3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "13a66e6d-f08c-4060-aa98-f462989ff562",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13b842a8-8371-43d8-bd80-68d5670ad18c",
"db_currency_id": "18854873-de38-42ad-bf9e-5b48a47e1c9b",
"db_language_id": "e03ceb7c-15f3-45b9-bb1e-cf9dae9e10cf",
"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-03-06T07:48:57.0650887+00:00"
},
"modified_dateutc": "2026-03-06T07:48:57.0807137+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c865c80a-c608-4e48-ba23-fb1328fb283b",
"date_reported_by_company": "2026-03-06T07:48:57.0807137+00:00",
"id2": 36,
"company_id": "a24cd387-7368-479c-9a6d-ebff12a27b76",
"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": "4536ab68-b371-4be6-bfaa-8548a91d344f",
"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-03-06T07:48:57.0807137+00:00"
},
"work_instruction_details_id": "9f6ee455-51ea-4289-852d-f0e1a22fe167",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3906b27e-20d8-45a3-995e-4d445d861757",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "31869586-88d7-46a4-b5d8-839578fac894",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-06T07:48:57.0807137+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": "b1b66f85-f6fc-40e6-a22f-753e3ef0c947",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-06T07:48:57.0807137+00:00"
}