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": "57d8c4c6-8f2c-4882-a65b-f78db79d922c",
"jobs_id": "afda132d-11f2-4c84-b9ed-a9446bb12576",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "76b54600-50b5-4419-b54b-e9fc52c02ed8",
"_parent_id": "e4b88dd5-b8e5-464e-993a-5187df62135d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8af87c9e-3de2-4630-affc-522c0bd57676",
"project_reference_back_office": "sample string 5",
"project": {
"id": "14abe83e-2b55-4231-9fa4-9c3cf3214f97",
"_parent_id": "fa3a3777-75ab-4176-bfe7-ef4e12091185",
"root_parent_id": "08d211b8-c577-492c-928f-6574bd5412f8",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "63e90016-68fe-4796-ae49-5dad5d49a80c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4120b6e9-9a27-4077-a3af-bd5884994eae",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "447b1937-2046-47f1-a95a-370f39d5467e",
"_parent_code": "sample string 6",
"sales_organization_id": "da941be9-55cc-437a-891f-bfb7fc73d5d8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "457d60ff-5874-401a-95a3-0312cfaad032",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c00c813c-f032-429f-bd64-37ad70d048f4",
"db_currency_id": "1fb16189-496f-417e-ab97-fdb4f84b6f62",
"db_language_id": "a0ebc3d5-201a-4e3f-b2f5-d4813cafcde1",
"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-01T00:55:22.4834602+00:00"
},
"modified_dateutc": "2026-07-01T00:55:22.4834602+00:00"
},
"equipment_model_id": "e5aea308-072f-4b51-9471-7bcecd09bfc5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "21f3ee15-60f4-4c34-b594-e377e7bb2fdc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "dfb90a3f-7aa6-4559-848c-583e8fd803e4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e7107682-69e5-465f-8edb-79f028b33d9a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d72d0276-67e3-41e6-af8e-bdc86aeb1199",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "457d60ff-5874-401a-95a3-0312cfaad032",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c00c813c-f032-429f-bd64-37ad70d048f4",
"db_currency_id": "1fb16189-496f-417e-ab97-fdb4f84b6f62",
"db_language_id": "a0ebc3d5-201a-4e3f-b2f5-d4813cafcde1",
"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-01T00:55:22.4834602+00:00"
},
"modified_dateutc": "2026-07-01T00:55:22.4834602+00:00"
},
"equipment_family_id": "313adfd6-05e1-4b04-a0ac-bc734decbf91",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4120b6e9-9a27-4077-a3af-bd5884994eae",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "447b1937-2046-47f1-a95a-370f39d5467e",
"_parent_code": "sample string 6",
"sales_organization_id": "da941be9-55cc-437a-891f-bfb7fc73d5d8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "457d60ff-5874-401a-95a3-0312cfaad032",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c00c813c-f032-429f-bd64-37ad70d048f4",
"db_currency_id": "1fb16189-496f-417e-ab97-fdb4f84b6f62",
"db_language_id": "a0ebc3d5-201a-4e3f-b2f5-d4813cafcde1",
"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-01T00:55:22.4834602+00:00"
},
"modified_dateutc": "2026-07-01T00:55:22.4834602+00:00"
},
"date_in_production_since": "2026-07-01T00:55:22.4834602+00:00",
"date_out_of_production_since": "2026-07-01T00:55:22.4834602+00:00",
"date_end_support": "2026-07-01T00:55:22.4834602+00:00",
"sales_organization_id": "201c1196-bf98-4c84-8d9f-d343ed43e555",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "457d60ff-5874-401a-95a3-0312cfaad032",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c00c813c-f032-429f-bd64-37ad70d048f4",
"db_currency_id": "1fb16189-496f-417e-ab97-fdb4f84b6f62",
"db_language_id": "a0ebc3d5-201a-4e3f-b2f5-d4813cafcde1",
"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-01T00:55:22.4834602+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-01T00:55:22.4834602+00:00"
},
"project_status_id": "1e699bfe-8be0-425f-b746-5e6741ad96a3",
"project_status_code": "sample string 10",
"project_status": {
"id": "50a62d20-1ff6-4b15-ac64-8516a3a737a0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "50bbc57c-796f-4205-8c1f-19462f201c57",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "457d60ff-5874-401a-95a3-0312cfaad032",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c00c813c-f032-429f-bd64-37ad70d048f4",
"db_currency_id": "1fb16189-496f-417e-ab97-fdb4f84b6f62",
"db_language_id": "a0ebc3d5-201a-4e3f-b2f5-d4813cafcde1",
"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-01T00:55:22.4834602+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-01T00:55:22.4834602+00:00"
},
"company_id": "565cb1f3-b5ae-43e7-997e-7118fcdb267e",
"company_code": "sample string 12",
"db_address_id": "eca39be7-f1f1-4183-b2ab-3867c7e0d5b3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "da4d2acf-b247-4c23-96a3-ffccd7782f7f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "15231e8e-8fef-4bf9-8061-5cf0a2697b5c",
"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-01T00:55:22.4834602+00:00",
"date_create": "2026-07-01T00:55:22.4834602+00:00",
"date_update": "2026-07-01T00:55:22.4834602+00:00",
"updated_by_user_id": "58c303fb-50c2-4290-8484-3f56ba5c1a0b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-01T00:55:22.4834602+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-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-01T00:55:22.4834602+00:00",
"date_last_job": "2026-07-01T00:55:22.4834602+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-01T00:55:22.4834602+00:00",
"modified_dateutc": "2026-07-01T00:55:22.4834602+00:00",
"is_mobile_installation": true
},
"job_type_id": "3b0ac435-7bd1-41c0-b4bd-7751dab1a785",
"job_type_code": "sample string 7",
"job_type": {
"id": "f01e7200-9d69-498e-805f-cb99220df5a8",
"name": "sample string 2",
"sales_organization_id": "3054daa4-711f-42b1-b023-3740cbb5cd66",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-01T00:55:22.4834602+00:00",
"code": "sample string 7"
},
"job_priority_id": "fa729143-7909-4ebb-ad81-8e03a82def55",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "341cc134-9857-4d6e-876a-64aababfd3aa",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6e9619fa-190b-463a-8b9f-cccb0603c611",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "457d60ff-5874-401a-95a3-0312cfaad032",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c00c813c-f032-429f-bd64-37ad70d048f4",
"db_currency_id": "1fb16189-496f-417e-ab97-fdb4f84b6f62",
"db_language_id": "a0ebc3d5-201a-4e3f-b2f5-d4813cafcde1",
"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-01T00:55:22.4834602+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-01T00:55:22.4834602+00:00"
},
"job_status_id": "f1e38251-13b1-455b-86ac-900920da013d",
"job_status_code": "sample string 11",
"db_address_id": "3d21f96e-ce63-43d5-8b7e-bd2049df20d3",
"contact_id": "61ca6543-4d91-46f3-8114-acfeb8207349",
"requested_by_company_id": "bb7b2ce4-7cc0-4798-b192-2ea1c6c7f228",
"requested_by_contact_id": "16f2d7eb-4220-4edc-a229-68da0566a133",
"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-01T00:55:22.4834602+00:00",
"due_date": "2026-07-01T00:55:22.4834602+00:00",
"date_create": "2026-07-01T00:55:22.4834602+00:00",
"date_update": "2026-07-01T00:55:22.4834602+00:00",
"date_closed": "2026-07-01T00:55:22.4834602+00:00",
"suggested_user_id": "2a14a259-39a4-4749-89c5-af77c63d8802",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "65239cd6-5ffe-4d78-8622-b8f4dc3fcb3d",
"db_language_id": "1a5b7569-0c49-4136-8646-e0c55df45766",
"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-01T00:55:22.4834602+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4e3a700c-831a-4aa9-adbe-0876b770a829",
"sales_organization": {
"id": "457d60ff-5874-401a-95a3-0312cfaad032",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c00c813c-f032-429f-bd64-37ad70d048f4",
"db_currency_id": "1fb16189-496f-417e-ab97-fdb4f84b6f62",
"db_language_id": "a0ebc3d5-201a-4e3f-b2f5-d4813cafcde1",
"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-01T00:55:22.4834602+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ceeb0e43-a846-4cb0-8f8f-9c9ba8daf2dd",
"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": "b463bf21-b83f-40db-a214-8ed75490d9e1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-01T00:55:22.4834602+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6d4a33ce-24b2-4b41-b64f-231d1088a872"
},
"suggested_date_start": "2026-07-01T00:55:22.4834602+00:00",
"skill_id": "07e6fd4d-40b2-4d91-aa51-67be5c8789e5",
"skill_code": "sample string 32",
"skill": {
"id": "12c50a34-062c-4649-86bd-5b945df33d8d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "095e9179-03d2-4a7c-ab28-3cecb66cee9b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "457d60ff-5874-401a-95a3-0312cfaad032",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c00c813c-f032-429f-bd64-37ad70d048f4",
"db_currency_id": "1fb16189-496f-417e-ab97-fdb4f84b6f62",
"db_language_id": "a0ebc3d5-201a-4e3f-b2f5-d4813cafcde1",
"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-01T00:55:22.4834602+00:00"
},
"modified_dateutc": "2026-07-01T00:55:22.4834602+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "48254fc3-61b6-4efc-96f8-bb0036e68ff1",
"date_reported_by_company": "2026-07-01T00:55:22.4834602+00:00",
"id2": 36,
"company_id": "591874bd-3fd1-4537-b151-10d02e66eea5",
"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": "0e9a1ba9-0309-49ca-8acc-b226a84c7d62",
"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-01T00:55:22.4834602+00:00"
},
"work_instruction_details_id": "487b8a2e-9acf-4233-8f55-c0f2de2ee941",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "574c8092-900b-4e72-a664-344560169f1c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6d74a3d4-fc00-4674-aa41-aa4c3aa70447",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-01T00:55:22.4834602+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": "4ccca24d-1ee8-4bca-ac81-d6e81a91118f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-01T00:55:22.4834602+00:00"
}