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": "9379b6b1-f0b9-4d89-ab83-68c849d17e2b",
"jobs_id": "6c8fdbbf-1927-4953-8317-e404c832bf56",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fc93414c-ea3d-47c3-8bd9-fdde28d8df25",
"_parent_id": "7e5402b5-3d62-4c5e-8b82-6a2d73504724",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b84ba1c6-7367-4b27-b16a-fbe58d614532",
"project_reference_back_office": "sample string 5",
"project": {
"id": "78562cf7-6465-409e-a664-0a5aafc6fa28",
"_parent_id": "a0996582-2b53-4528-b5f6-d6b17685200a",
"root_parent_id": "92b1f1f8-6f70-4752-9420-e72973414744",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "92e6661e-2570-4f11-8f99-9477fa2358ee",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c1742101-a439-46ff-b3f9-79894d0a2d11",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bc643136-a808-45c6-943d-c9adc6337bc7",
"_parent_code": "sample string 6",
"sales_organization_id": "7ff71ac4-290f-48e9-ae05-4920f57caebb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "144bd99b-95dd-4395-9ecc-34bc21d36ea1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "675a8a2e-c924-4fa0-b54e-95ccbb3e5ff9",
"db_currency_id": "b87618ca-a12e-4dd2-bc5f-88b76e94c61e",
"db_language_id": "7b636f63-7e5a-4257-864b-ade4ff1aac1c",
"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-04T07:10:14.5561997+00:00"
},
"modified_dateutc": "2026-07-04T07:10:14.5561997+00:00"
},
"equipment_model_id": "c64e718a-2744-4b2d-8b9c-4061b696d2bf",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "854a0fc4-111f-45e1-a3a5-4e40495730e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f08dd316-4765-4131-a1ee-cccb328be399",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "82f41e11-8941-4b99-a5a2-951c897c89ab",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2daaf59c-faaf-4af4-a6c8-7cd860899548",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "144bd99b-95dd-4395-9ecc-34bc21d36ea1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "675a8a2e-c924-4fa0-b54e-95ccbb3e5ff9",
"db_currency_id": "b87618ca-a12e-4dd2-bc5f-88b76e94c61e",
"db_language_id": "7b636f63-7e5a-4257-864b-ade4ff1aac1c",
"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-04T07:10:14.5561997+00:00"
},
"modified_dateutc": "2026-07-04T07:10:14.5561997+00:00"
},
"equipment_family_id": "0c8a1788-bd5b-4136-9aab-de0290c0247b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c1742101-a439-46ff-b3f9-79894d0a2d11",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bc643136-a808-45c6-943d-c9adc6337bc7",
"_parent_code": "sample string 6",
"sales_organization_id": "7ff71ac4-290f-48e9-ae05-4920f57caebb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "144bd99b-95dd-4395-9ecc-34bc21d36ea1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "675a8a2e-c924-4fa0-b54e-95ccbb3e5ff9",
"db_currency_id": "b87618ca-a12e-4dd2-bc5f-88b76e94c61e",
"db_language_id": "7b636f63-7e5a-4257-864b-ade4ff1aac1c",
"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-04T07:10:14.5561997+00:00"
},
"modified_dateutc": "2026-07-04T07:10:14.5561997+00:00"
},
"date_in_production_since": "2026-07-04T07:10:14.5561997+00:00",
"date_out_of_production_since": "2026-07-04T07:10:14.5561997+00:00",
"date_end_support": "2026-07-04T07:10:14.5561997+00:00",
"sales_organization_id": "244f50e7-7259-49db-962f-b710606729ce",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "144bd99b-95dd-4395-9ecc-34bc21d36ea1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "675a8a2e-c924-4fa0-b54e-95ccbb3e5ff9",
"db_currency_id": "b87618ca-a12e-4dd2-bc5f-88b76e94c61e",
"db_language_id": "7b636f63-7e5a-4257-864b-ade4ff1aac1c",
"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-04T07:10:14.5561997+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-04T07:10:14.5561997+00:00"
},
"project_status_id": "54d71dd9-fbf9-4bf6-8352-01849e2579ee",
"project_status_code": "sample string 10",
"project_status": {
"id": "890618b8-e2bf-4624-a64c-f7f4a388e1d4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1403d1c2-6bfe-4515-a508-8425cfeb4579",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "144bd99b-95dd-4395-9ecc-34bc21d36ea1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "675a8a2e-c924-4fa0-b54e-95ccbb3e5ff9",
"db_currency_id": "b87618ca-a12e-4dd2-bc5f-88b76e94c61e",
"db_language_id": "7b636f63-7e5a-4257-864b-ade4ff1aac1c",
"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-04T07:10:14.5561997+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-04T07:10:14.5561997+00:00"
},
"company_id": "799969b7-da94-45a0-a3bf-6d49d201058f",
"company_code": "sample string 12",
"db_address_id": "a37ae9cf-fdd6-42c4-bd5d-bf925bbde055",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "aca7d044-b2e9-4101-8ae9-289d7feff7b5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "11244e5a-f5f5-4002-82a2-1cfdbfc5d6ef",
"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-04T07:10:14.5561997+00:00",
"date_create": "2026-07-04T07:10:14.5561997+00:00",
"date_update": "2026-07-04T07:10:14.5561997+00:00",
"updated_by_user_id": "c72d9d3f-e64e-41ff-a823-e4b154240a91",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-04T07:10:14.5561997+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-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-04T07:10:14.5561997+00:00",
"date_last_job": "2026-07-04T07:10:14.5561997+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-04T07:10:14.5561997+00:00",
"modified_dateutc": "2026-07-04T07:10:14.5561997+00:00",
"is_mobile_installation": true
},
"job_type_id": "92749ee7-53f2-45fe-858c-0c67856b5d9e",
"job_type_code": "sample string 7",
"job_type": {
"id": "db56e416-4d63-4fc2-93eb-d01268154fb6",
"name": "sample string 2",
"sales_organization_id": "fa1707c4-2038-4165-ba4c-96cf5f82e851",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-04T07:10:14.5561997+00:00",
"code": "sample string 7"
},
"job_priority_id": "3e211179-e4d4-4ebc-b2fa-8a3399a9a06c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1c9300ef-7dfd-449e-8ff2-693e40eedbfa",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "94b3c114-351e-4590-82c8-6f950714e188",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "144bd99b-95dd-4395-9ecc-34bc21d36ea1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "675a8a2e-c924-4fa0-b54e-95ccbb3e5ff9",
"db_currency_id": "b87618ca-a12e-4dd2-bc5f-88b76e94c61e",
"db_language_id": "7b636f63-7e5a-4257-864b-ade4ff1aac1c",
"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-04T07:10:14.5561997+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-04T07:10:14.5561997+00:00"
},
"job_status_id": "e9f23e24-b50b-4218-a920-c52876da22e2",
"job_status_code": "sample string 11",
"db_address_id": "833bf05b-6886-42f6-b46b-be24ee5cb25c",
"contact_id": "48118994-b800-45d1-94dc-5d15a146b017",
"requested_by_company_id": "e1144b5a-83a0-4977-aa65-0f7c9f089824",
"requested_by_contact_id": "82f05685-ce5f-4779-83e0-4254c9e5c3f8",
"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-04T07:10:14.5561997+00:00",
"due_date": "2026-07-04T07:10:14.5561997+00:00",
"date_create": "2026-07-04T07:10:14.5561997+00:00",
"date_update": "2026-07-04T07:10:14.5561997+00:00",
"date_closed": "2026-07-04T07:10:14.5561997+00:00",
"suggested_user_id": "50beb638-17ef-48a3-ab3b-04a8198779db",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "87dca576-e86e-4aff-8f26-644011b54b1a",
"db_language_id": "8b5c42ea-7cd7-4c4a-ac5b-a174678d7962",
"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-04T07:10:14.5561997+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3074e37e-4dc8-422a-8bdb-0c5ef56c214e",
"sales_organization": {
"id": "144bd99b-95dd-4395-9ecc-34bc21d36ea1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "675a8a2e-c924-4fa0-b54e-95ccbb3e5ff9",
"db_currency_id": "b87618ca-a12e-4dd2-bc5f-88b76e94c61e",
"db_language_id": "7b636f63-7e5a-4257-864b-ade4ff1aac1c",
"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-04T07:10:14.5561997+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "af43ca7b-c918-4b03-8e9b-e6e146376412",
"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": "f2856b39-c83a-45fb-9000-013b7e195505",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-04T07:10:14.5561997+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ef77894a-beaa-4842-bbd6-aceb416079b5"
},
"suggested_date_start": "2026-07-04T07:10:14.5561997+00:00",
"skill_id": "da366ad0-d482-4356-9da9-fc48aeb201c6",
"skill_code": "sample string 32",
"skill": {
"id": "f07b79e0-cb5a-4d76-be8c-45f94d09273f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6062158b-a93d-44ad-b5cf-7995e92af57f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "144bd99b-95dd-4395-9ecc-34bc21d36ea1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "675a8a2e-c924-4fa0-b54e-95ccbb3e5ff9",
"db_currency_id": "b87618ca-a12e-4dd2-bc5f-88b76e94c61e",
"db_language_id": "7b636f63-7e5a-4257-864b-ade4ff1aac1c",
"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-04T07:10:14.5561997+00:00"
},
"modified_dateutc": "2026-07-04T07:10:14.5561997+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2f606e26-696c-4f5a-8cdc-da61696b8528",
"date_reported_by_company": "2026-07-04T07:10:14.5561997+00:00",
"id2": 36,
"company_id": "387a84d4-3ac3-4701-a1ab-39bfd54440ac",
"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": "0cb7a09a-9489-41c6-9acc-950e477a4ea0",
"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-04T07:10:14.5561997+00:00"
},
"work_instruction_details_id": "de0f7081-a97d-48c6-96bb-c7bfd2cf6727",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b6dab400-3db8-4596-aa45-dfba77d92aae",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4c2df130-69e3-4127-af20-fd1445a754a9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-04T07:10:14.5561997+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": "40d0b2b6-f590-4cb7-87e3-8192ff5d9dda",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-04T07:10:14.5561997+00:00"
}