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": "34fcf85d-3dfd-4cf1-9449-34bbdbe3afb6",
"jobs_id": "cb48f237-ca49-4771-bc9a-4afef03d33f9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4dec30b6-643e-4a80-854e-3b94b6a52f1c",
"_parent_id": "54aa7ff1-4b3a-49d2-9a11-869c23911752",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "635d4ce6-6c6e-4e52-929e-217df93567ea",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c76313a8-1b2f-420e-a99d-e1e6712e9ac1",
"_parent_id": "4d16be25-b0f4-484c-b540-7428ca0ab8af",
"root_parent_id": "31a3aad5-566b-45da-97fc-e5cb944c86f3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "25435755-28b3-42ba-87a9-87a370041d24",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "886da65d-2265-4153-964e-57e9c6ae32c5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "85956ebb-9c15-4efd-9c84-2c14bb4d87ed",
"_parent_code": "sample string 6",
"sales_organization_id": "601ea15e-e4ce-4a48-8727-01ba8d0e628f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cf658949-3554-484d-abdd-543ddfc76248",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38b46839-0237-41f3-80e6-7b2d38a81e7c",
"db_currency_id": "853c1b54-4b26-41f6-8a29-a361c47b1e35",
"db_language_id": "5916dcbc-60df-41af-a7ab-446fcffa7dca",
"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-30T14:08:43.1345967+00:00"
},
"modified_dateutc": "2026-09-30T14:08:43.1345967+00:00"
},
"equipment_model_id": "3e0c2d7c-ad7d-4623-910e-87848638587f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e963424e-9b7b-4c71-b19d-294c6abd3117",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d71ed519-ccf5-4d1f-a3de-60a5bdf33ebb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a7e3590b-ce3a-4de8-8422-33ab3c7fcb7c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "595aa8ea-d9bd-48d6-ba03-3bf9d1b668ab",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cf658949-3554-484d-abdd-543ddfc76248",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38b46839-0237-41f3-80e6-7b2d38a81e7c",
"db_currency_id": "853c1b54-4b26-41f6-8a29-a361c47b1e35",
"db_language_id": "5916dcbc-60df-41af-a7ab-446fcffa7dca",
"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-30T14:08:43.1345967+00:00"
},
"modified_dateutc": "2026-09-30T14:08:43.1345967+00:00"
},
"equipment_family_id": "66292c90-f3d8-4046-a1d7-b9ca9acaa3a1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "886da65d-2265-4153-964e-57e9c6ae32c5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "85956ebb-9c15-4efd-9c84-2c14bb4d87ed",
"_parent_code": "sample string 6",
"sales_organization_id": "601ea15e-e4ce-4a48-8727-01ba8d0e628f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cf658949-3554-484d-abdd-543ddfc76248",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38b46839-0237-41f3-80e6-7b2d38a81e7c",
"db_currency_id": "853c1b54-4b26-41f6-8a29-a361c47b1e35",
"db_language_id": "5916dcbc-60df-41af-a7ab-446fcffa7dca",
"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-30T14:08:43.1345967+00:00"
},
"modified_dateutc": "2026-09-30T14:08:43.1345967+00:00"
},
"date_in_production_since": "2026-09-30T14:08:43.1345967+00:00",
"date_out_of_production_since": "2026-09-30T14:08:43.1345967+00:00",
"date_end_support": "2026-09-30T14:08:43.1345967+00:00",
"sales_organization_id": "7dad954f-d986-4658-920a-c1270338e009",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cf658949-3554-484d-abdd-543ddfc76248",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38b46839-0237-41f3-80e6-7b2d38a81e7c",
"db_currency_id": "853c1b54-4b26-41f6-8a29-a361c47b1e35",
"db_language_id": "5916dcbc-60df-41af-a7ab-446fcffa7dca",
"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-30T14:08:43.1345967+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-30T14:08:43.1547129+00:00"
},
"project_status_id": "f8760a77-32af-4c1b-9221-97f517f888f2",
"project_status_code": "sample string 10",
"project_status": {
"id": "64cb328d-dc40-4583-9c67-d64217ddd79b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "94f26216-4028-4cc7-b88a-a9037c375d64",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cf658949-3554-484d-abdd-543ddfc76248",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38b46839-0237-41f3-80e6-7b2d38a81e7c",
"db_currency_id": "853c1b54-4b26-41f6-8a29-a361c47b1e35",
"db_language_id": "5916dcbc-60df-41af-a7ab-446fcffa7dca",
"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-30T14:08:43.1345967+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-30T14:08:43.1547129+00:00"
},
"company_id": "9796f8dc-d9e7-4ae9-abe8-9491ab88741d",
"company_code": "sample string 12",
"db_address_id": "2f0a2c57-fc52-4c7f-bc45-ac0b0f197d99",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "cfd2df18-a1d3-4424-b93d-04d33f1ac381",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e71fba72-df3b-4717-a23c-4379facc1abf",
"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-30T14:08:43.1547129+00:00",
"date_create": "2026-09-30T14:08:43.1547129+00:00",
"date_update": "2026-09-30T14:08:43.1547129+00:00",
"updated_by_user_id": "d099ef21-71e9-498c-a885-f1555a91f698",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-30T14:08:43.1547129+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-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-30T14:08:43.1547129+00:00",
"date_last_job": "2026-09-30T14:08:43.1547129+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-30T14:08:43.1547129+00:00",
"modified_dateutc": "2026-09-30T14:08:43.1547129+00:00",
"is_mobile_installation": true
},
"job_type_id": "cacb61d5-76fe-4a3b-ae3d-864fc8f44341",
"job_type_code": "sample string 7",
"job_type": {
"id": "8f438845-c133-4ec0-9676-2e8c0d3cec6b",
"name": "sample string 2",
"sales_organization_id": "a34f9104-0d50-4512-905b-bf80faa0c9f4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-30T14:08:43.1547129+00:00",
"code": "sample string 7"
},
"job_priority_id": "51ac6108-b469-49b5-b4c6-113118b2d28b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "72117003-26c5-40c6-8ea1-6288f8f9169c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "19b92955-897b-4103-b9ca-3335e35a4ad9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cf658949-3554-484d-abdd-543ddfc76248",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38b46839-0237-41f3-80e6-7b2d38a81e7c",
"db_currency_id": "853c1b54-4b26-41f6-8a29-a361c47b1e35",
"db_language_id": "5916dcbc-60df-41af-a7ab-446fcffa7dca",
"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-30T14:08:43.1345967+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-30T14:08:43.1547129+00:00"
},
"job_status_id": "5a30624d-83e6-4c1b-bdfe-1be73a8615b9",
"job_status_code": "sample string 11",
"db_address_id": "c78b9886-b48d-456c-9be6-2743bad616a2",
"contact_id": "e0a2e7aa-a3f3-4ff1-b505-21cb235cf06c",
"requested_by_company_id": "5745f794-961c-4121-a0d7-78f6a8d46142",
"requested_by_contact_id": "26105051-192d-4dc4-ba87-c6649bf55d50",
"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-30T14:08:43.1547129+00:00",
"due_date": "2026-09-30T14:08:43.1547129+00:00",
"date_create": "2026-09-30T14:08:43.1547129+00:00",
"date_update": "2026-09-30T14:08:43.1547129+00:00",
"date_closed": "2026-09-30T14:08:43.1547129+00:00",
"suggested_user_id": "2b73ea51-33a9-4b4d-a085-009a7e3aa050",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "86a256d8-f104-446e-a29a-f06def7e6885",
"db_language_id": "86ca5ebe-d7cf-4773-94e7-84a9725345d8",
"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-30T14:08:43.1547129+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "12376acb-9383-472f-aea4-11cb1403d81f",
"sales_organization": {
"id": "cf658949-3554-484d-abdd-543ddfc76248",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38b46839-0237-41f3-80e6-7b2d38a81e7c",
"db_currency_id": "853c1b54-4b26-41f6-8a29-a361c47b1e35",
"db_language_id": "5916dcbc-60df-41af-a7ab-446fcffa7dca",
"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-30T14:08:43.1345967+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c7deb411-62ab-426c-b344-ad1624cb5c74",
"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": "6a8472c8-ca9b-499b-815a-1fcafba7e1b5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-30T14:08:43.1547129+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "999f2ecb-6495-42bb-9287-98f0b3ed10d2"
},
"suggested_date_start": "2026-09-30T14:08:43.1547129+00:00",
"skill_id": "a4ed7b45-e7c2-4f7c-894a-641e3dfd07f5",
"skill_code": "sample string 32",
"skill": {
"id": "397fb795-80c6-4b44-bfc1-3d34dc5e7ed0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9951fbff-3e2a-445d-8d39-f5838b8209a3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cf658949-3554-484d-abdd-543ddfc76248",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38b46839-0237-41f3-80e6-7b2d38a81e7c",
"db_currency_id": "853c1b54-4b26-41f6-8a29-a361c47b1e35",
"db_language_id": "5916dcbc-60df-41af-a7ab-446fcffa7dca",
"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-30T14:08:43.1345967+00:00"
},
"modified_dateutc": "2026-09-30T14:08:43.1547129+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "469d545d-3c59-4097-8284-7fdd07a5ad0a",
"date_reported_by_company": "2026-09-30T14:08:43.1547129+00:00",
"id2": 36,
"company_id": "823af2a2-bb98-41e0-aa0f-5b1bbb9a7b31",
"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": "57841c44-133d-46bf-8986-6c6cbf5e2021",
"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-30T14:08:43.1547129+00:00"
},
"work_instruction_details_id": "f691a610-e5ec-44df-a6ad-7181f7e0b014",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b8b71965-d570-4646-9dca-b2bdd1475b71",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e279138f-7ebb-4b97-b6ca-8f872a9d0986",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-30T14:08:43.1646945+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": "ef37c65c-c3bf-4e76-bc13-913bd24edace",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-30T14:08:43.1646945+00:00"
}