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": "802a8ed1-1f24-4562-8050-d93d0530043a",
"jobs_id": "dff19c44-ed95-443f-9cee-7f507077e887",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4201cd18-7dbd-45f5-b999-5b6cb610a928",
"_parent_id": "5a4eeb52-49a6-4e27-8e05-d6efc358c2c8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0134c51d-52ec-42ab-a35f-07c614927a47",
"project_reference_back_office": "sample string 5",
"project": {
"id": "fb557b27-86ec-47d4-80ff-fd5dbae0d57c",
"_parent_id": "3c39de3d-5a4b-47e8-aa97-d78f206f4ac0",
"root_parent_id": "c96ec03d-ac57-421b-967f-9ddec7fd9209",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "27a1c649-b534-4827-a208-0f506b2d7c42",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3d8deb41-3cd2-4ced-a002-12bbd39af506",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e80d1851-f93f-4874-9555-3b32fc2de3ec",
"_parent_code": "sample string 6",
"sales_organization_id": "09d5a94d-5ce5-4b79-b437-c1ec677e8d82",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7c613001-7720-4858-9daa-986d02ad36e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54d91ca0-998b-4a2d-a505-888d3b4fed89",
"db_currency_id": "29a1bd21-9fdd-4138-b5a6-dfc082773cb1",
"db_language_id": "8820fc04-9bdf-4a69-ad41-ad959fcdb2aa",
"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-09-08T22:14:15.6890127+00:00"
},
"modified_dateutc": "2026-09-08T22:14:15.6890127+00:00"
},
"equipment_model_id": "c7af9364-5271-4e65-a679-d67b3de5ae6a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "cc1d6356-18be-4f3b-b8b1-e1853145d541",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "438de88a-2873-41b1-bc63-a41b3b37243b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "70994a66-319e-4aca-9f54-956f7f37d295",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fad7cca4-8a68-4a06-ad98-7ead1aa216ed",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7c613001-7720-4858-9daa-986d02ad36e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54d91ca0-998b-4a2d-a505-888d3b4fed89",
"db_currency_id": "29a1bd21-9fdd-4138-b5a6-dfc082773cb1",
"db_language_id": "8820fc04-9bdf-4a69-ad41-ad959fcdb2aa",
"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-09-08T22:14:15.6890127+00:00"
},
"modified_dateutc": "2026-09-08T22:14:15.6890127+00:00"
},
"equipment_family_id": "2cc27962-3957-4574-a160-cbab3a315cb3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3d8deb41-3cd2-4ced-a002-12bbd39af506",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e80d1851-f93f-4874-9555-3b32fc2de3ec",
"_parent_code": "sample string 6",
"sales_organization_id": "09d5a94d-5ce5-4b79-b437-c1ec677e8d82",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7c613001-7720-4858-9daa-986d02ad36e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54d91ca0-998b-4a2d-a505-888d3b4fed89",
"db_currency_id": "29a1bd21-9fdd-4138-b5a6-dfc082773cb1",
"db_language_id": "8820fc04-9bdf-4a69-ad41-ad959fcdb2aa",
"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-09-08T22:14:15.6890127+00:00"
},
"modified_dateutc": "2026-09-08T22:14:15.6890127+00:00"
},
"date_in_production_since": "2026-09-08T22:14:15.6890127+00:00",
"date_out_of_production_since": "2026-09-08T22:14:15.6890127+00:00",
"date_end_support": "2026-09-08T22:14:15.6890127+00:00",
"sales_organization_id": "fced5539-d9f6-44a8-8e95-b21cebc1defe",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7c613001-7720-4858-9daa-986d02ad36e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54d91ca0-998b-4a2d-a505-888d3b4fed89",
"db_currency_id": "29a1bd21-9fdd-4138-b5a6-dfc082773cb1",
"db_language_id": "8820fc04-9bdf-4a69-ad41-ad959fcdb2aa",
"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-09-08T22:14:15.6890127+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-09-08T22:14:15.6890127+00:00"
},
"project_status_id": "0e01ad0a-1422-4539-b480-7a25b66d3f93",
"project_status_code": "sample string 10",
"project_status": {
"id": "89efa548-17aa-4fe1-96d8-3b9f54bc352b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cb2938a7-e8fa-4458-9c23-2517ce1b40b5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7c613001-7720-4858-9daa-986d02ad36e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54d91ca0-998b-4a2d-a505-888d3b4fed89",
"db_currency_id": "29a1bd21-9fdd-4138-b5a6-dfc082773cb1",
"db_language_id": "8820fc04-9bdf-4a69-ad41-ad959fcdb2aa",
"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-09-08T22:14:15.6890127+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-08T22:14:15.6890127+00:00"
},
"company_id": "d67fd3c6-fcba-4c1b-a1e4-2fb157a7e9cc",
"company_code": "sample string 12",
"db_address_id": "2537aca7-45e8-43b6-b38e-55003d1389d9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "af9cbcb1-2c6b-41ae-b193-c49c74331bf8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f87708f5-2232-4195-8ee8-7e2216535dcd",
"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-09-08T22:14:15.6890127+00:00",
"date_create": "2026-09-08T22:14:15.6890127+00:00",
"date_update": "2026-09-08T22:14:15.6890127+00:00",
"updated_by_user_id": "7e7be6b9-5b21-4850-8132-930f2104c50b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-08T22:14:15.6890127+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-09-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-08T22:14:15.6890127+00:00",
"date_last_job": "2026-09-08T22:14:15.6890127+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-08T22:14:15.6890127+00:00",
"modified_dateutc": "2026-09-08T22:14:15.6890127+00:00",
"is_mobile_installation": true
},
"job_type_id": "76fb4b2f-6e5c-4e49-8d16-28e0c05d3d19",
"job_type_code": "sample string 7",
"job_type": {
"id": "2350dfa1-c270-42c2-bb24-adc1a00fd13c",
"name": "sample string 2",
"sales_organization_id": "464c7d42-4a1d-42e0-b39e-8e98f6b946cc",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-08T22:14:15.6890127+00:00",
"code": "sample string 7"
},
"job_priority_id": "2a1a33c8-e3c3-4eea-89b7-71b8efdf22f5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "276fb4a4-f21a-44d8-bb89-18d62b7c9310",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c5c1da98-5f01-4a2b-8f74-2b6546fec5f3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7c613001-7720-4858-9daa-986d02ad36e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54d91ca0-998b-4a2d-a505-888d3b4fed89",
"db_currency_id": "29a1bd21-9fdd-4138-b5a6-dfc082773cb1",
"db_language_id": "8820fc04-9bdf-4a69-ad41-ad959fcdb2aa",
"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-09-08T22:14:15.6890127+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-08T22:14:15.6890127+00:00"
},
"job_status_id": "66bfbde1-7291-4886-9a59-ca5b785353cc",
"job_status_code": "sample string 11",
"db_address_id": "68b7504d-c6b2-4226-b82f-43f679327c90",
"contact_id": "1ce453f2-e64f-4e56-8867-7fce32a624de",
"requested_by_company_id": "aa371174-1233-40f3-9e97-d2d087f807a6",
"requested_by_contact_id": "77754d29-e3a2-47f4-afda-bc37538b5eab",
"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-09-08T22:14:15.6890127+00:00",
"due_date": "2026-09-08T22:14:15.6890127+00:00",
"date_create": "2026-09-08T22:14:15.6890127+00:00",
"date_update": "2026-09-08T22:14:15.6890127+00:00",
"date_closed": "2026-09-08T22:14:15.6890127+00:00",
"suggested_user_id": "b4b35595-0605-4f0f-a9c1-e8fcac70b5b8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "88f9e0ff-cb4e-4546-9c6d-1dc6494d6990",
"db_language_id": "6b697be0-924b-4bdf-9944-5d9d179655c9",
"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-09-08T22:14:15.6890127+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1842357a-f198-4b0a-a47f-8a92bb350f4a",
"sales_organization": {
"id": "7c613001-7720-4858-9daa-986d02ad36e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54d91ca0-998b-4a2d-a505-888d3b4fed89",
"db_currency_id": "29a1bd21-9fdd-4138-b5a6-dfc082773cb1",
"db_language_id": "8820fc04-9bdf-4a69-ad41-ad959fcdb2aa",
"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-09-08T22:14:15.6890127+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "991470ce-7dd5-476d-be64-e7d44e1d601d",
"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": "f00629c6-9c65-47f6-a73e-d847b129a084",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-08T22:14:15.6890127+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b6f8379b-17cd-40c7-9ee7-b6fcdf212219"
},
"suggested_date_start": "2026-09-08T22:14:15.6890127+00:00",
"skill_id": "4ff1f3c5-bca7-4e11-abed-0174894ea1ae",
"skill_code": "sample string 32",
"skill": {
"id": "9d631769-b355-4e11-b1e6-5f167fab66fd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b007a16b-9d20-4540-b9d1-43368da229b3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7c613001-7720-4858-9daa-986d02ad36e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "54d91ca0-998b-4a2d-a505-888d3b4fed89",
"db_currency_id": "29a1bd21-9fdd-4138-b5a6-dfc082773cb1",
"db_language_id": "8820fc04-9bdf-4a69-ad41-ad959fcdb2aa",
"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-09-08T22:14:15.6890127+00:00"
},
"modified_dateutc": "2026-09-08T22:14:15.6890127+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3a02bbda-7775-46a5-8401-0b234b7e41b1",
"date_reported_by_company": "2026-09-08T22:14:15.6890127+00:00",
"id2": 36,
"company_id": "a40ce606-9b18-4fa9-816e-ea38c6fd24dc",
"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": "9a5cf704-ab2c-4145-b222-b00d63424b20",
"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-09-08T22:14:15.6890127+00:00"
},
"work_instruction_details_id": "4daed982-b344-4909-811d-34043a726f70",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "212d308a-d15c-49ef-a6a1-1629cba00c97",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cdfbc3dd-5469-442c-b7f5-0d96f0766bab",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-08T22:14:15.6890127+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": "0da879d3-8253-4be5-bbae-53f24352c5cf",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-08T22:14:15.6890127+00:00"
}