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": "3c136dd2-9892-452c-9fa7-ae46f96e5604",
"jobs_id": "331f4d9c-7509-40f2-94e5-04601189b19a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1b945c7f-11ef-424e-b76d-2b4a8c4fe605",
"_parent_id": "b41e8a86-5c85-4d20-b4ff-5b7c9a273118",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7c49169e-5c72-4faa-9c69-9f89644f80ae",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e38f5f9d-7521-4f7d-9619-ba3305a07b91",
"_parent_id": "5d29def4-8828-402a-911d-649ff0317644",
"root_parent_id": "305216b4-7b5a-4350-9720-aa9a6774f9f7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "993d3083-c214-4471-8611-64dd0463b89a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9ba212b2-9ad0-4659-9b67-77dc5ac49b4a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "aff144ab-69de-487b-93a7-6a0f60738829",
"_parent_code": "sample string 6",
"sales_organization_id": "741f2f1f-0d67-41f2-88b8-72930a639609",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bf99cbc2-7463-4b0d-8d26-1e269a4c52c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b61b4ca-75d5-4e12-8399-2e927f93ed7d",
"db_currency_id": "2d47da38-cc86-4dbe-9d6d-4756176ebecb",
"db_language_id": "69c95563-89eb-4c55-9cc4-4b42adbf7786",
"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-10-22T07:27:54.4036317+00:00"
},
"modified_dateutc": "2026-10-22T07:27:54.4036317+00:00"
},
"equipment_model_id": "5f25a04e-ad8d-49e4-a59a-d3bfe3ea670a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "fedbd123-de9c-4681-a6bf-8dfd3e04bb37",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5ed1e15e-b9dd-4c51-b239-b4047a5f2a08",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "5e64db30-65c1-45dd-b4f8-e7cc7625b1b4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "319a687d-68ca-4478-9f80-74b2a1b6f226",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bf99cbc2-7463-4b0d-8d26-1e269a4c52c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b61b4ca-75d5-4e12-8399-2e927f93ed7d",
"db_currency_id": "2d47da38-cc86-4dbe-9d6d-4756176ebecb",
"db_language_id": "69c95563-89eb-4c55-9cc4-4b42adbf7786",
"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-10-22T07:27:54.4036317+00:00"
},
"modified_dateutc": "2026-10-22T07:27:54.4036317+00:00"
},
"equipment_family_id": "34297e7c-2082-42cc-892c-9aa6e8391f03",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9ba212b2-9ad0-4659-9b67-77dc5ac49b4a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "aff144ab-69de-487b-93a7-6a0f60738829",
"_parent_code": "sample string 6",
"sales_organization_id": "741f2f1f-0d67-41f2-88b8-72930a639609",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bf99cbc2-7463-4b0d-8d26-1e269a4c52c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b61b4ca-75d5-4e12-8399-2e927f93ed7d",
"db_currency_id": "2d47da38-cc86-4dbe-9d6d-4756176ebecb",
"db_language_id": "69c95563-89eb-4c55-9cc4-4b42adbf7786",
"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-10-22T07:27:54.4036317+00:00"
},
"modified_dateutc": "2026-10-22T07:27:54.4036317+00:00"
},
"date_in_production_since": "2026-10-22T07:27:54.4036317+00:00",
"date_out_of_production_since": "2026-10-22T07:27:54.4036317+00:00",
"date_end_support": "2026-10-22T07:27:54.4036317+00:00",
"sales_organization_id": "e88e326e-8484-4702-93ed-2448b96099c9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "bf99cbc2-7463-4b0d-8d26-1e269a4c52c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b61b4ca-75d5-4e12-8399-2e927f93ed7d",
"db_currency_id": "2d47da38-cc86-4dbe-9d6d-4756176ebecb",
"db_language_id": "69c95563-89eb-4c55-9cc4-4b42adbf7786",
"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-10-22T07:27:54.4036317+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-10-22T07:27:54.420861+00:00"
},
"project_status_id": "69de63cb-8d8f-40b0-bb15-132205865dad",
"project_status_code": "sample string 10",
"project_status": {
"id": "957391f5-c4cf-427a-9feb-957fcbf9db2d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "56c35518-8025-4d3b-821f-1796275b54c5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bf99cbc2-7463-4b0d-8d26-1e269a4c52c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b61b4ca-75d5-4e12-8399-2e927f93ed7d",
"db_currency_id": "2d47da38-cc86-4dbe-9d6d-4756176ebecb",
"db_language_id": "69c95563-89eb-4c55-9cc4-4b42adbf7786",
"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-10-22T07:27:54.4036317+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-22T07:27:54.420861+00:00"
},
"company_id": "f2bb97b7-14ea-475e-a670-9a4335726177",
"company_code": "sample string 12",
"db_address_id": "bfec91c5-dc7b-4578-9c3e-e659e4a88429",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0d522615-83d8-4f76-ba5c-08722bbc61d5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "43df01da-935a-4920-94ad-8559a357e60c",
"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-10-22T07:27:54.420861+00:00",
"date_create": "2026-10-22T07:27:54.420861+00:00",
"date_update": "2026-10-22T07:27:54.420861+00:00",
"updated_by_user_id": "a4c7b1a0-e429-476b-8511-8ad4ca0ecc43",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-22T07:27:54.420861+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-10-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-22T07:27:54.420861+00:00",
"date_last_job": "2026-10-22T07:27:54.420861+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-22T07:27:54.420861+00:00",
"modified_dateutc": "2026-10-22T07:27:54.420861+00:00",
"is_mobile_installation": true
},
"job_type_id": "fad599a2-e97d-4c1b-ba25-202d8c486d83",
"job_type_code": "sample string 7",
"job_type": {
"id": "7b6c7ac7-a582-4895-aaff-07baaf386a70",
"name": "sample string 2",
"sales_organization_id": "96550671-52e6-4c74-b713-61d1a098122f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-22T07:27:54.420861+00:00",
"code": "sample string 7"
},
"job_priority_id": "116ea78e-77f8-42a6-98dc-d65dd9d4427f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "02c5f2d9-2c65-4596-a22c-89972c0573ed",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "76fbddc0-c9d3-41a7-8e42-5a803623a1e8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bf99cbc2-7463-4b0d-8d26-1e269a4c52c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b61b4ca-75d5-4e12-8399-2e927f93ed7d",
"db_currency_id": "2d47da38-cc86-4dbe-9d6d-4756176ebecb",
"db_language_id": "69c95563-89eb-4c55-9cc4-4b42adbf7786",
"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-10-22T07:27:54.4036317+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-22T07:27:54.420861+00:00"
},
"job_status_id": "a3e1e2f5-aa3b-4333-98df-b4773ca088eb",
"job_status_code": "sample string 11",
"db_address_id": "e05801a4-972d-4221-9c66-960772d63a85",
"contact_id": "1902f245-c6f2-4cbf-b558-34d7213e3e9b",
"requested_by_company_id": "0d79e7db-dfbf-4823-a1a8-74420d52d87b",
"requested_by_contact_id": "40e85106-c4a2-4d97-98a4-46ccec534a73",
"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-10-22T07:27:54.420861+00:00",
"due_date": "2026-10-22T07:27:54.420861+00:00",
"date_create": "2026-10-22T07:27:54.420861+00:00",
"date_update": "2026-10-22T07:27:54.420861+00:00",
"date_closed": "2026-10-22T07:27:54.420861+00:00",
"suggested_user_id": "a138a6d4-9ecb-4128-ad9e-231360f79123",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f2cb2dca-2c98-4ab0-bba9-33a017d87140",
"db_language_id": "3978534b-7868-48f6-980c-210367c87b1f",
"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-10-22T07:27:54.420861+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a6733a4e-a29d-4167-9faf-767fbda26e73",
"sales_organization": {
"id": "bf99cbc2-7463-4b0d-8d26-1e269a4c52c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b61b4ca-75d5-4e12-8399-2e927f93ed7d",
"db_currency_id": "2d47da38-cc86-4dbe-9d6d-4756176ebecb",
"db_language_id": "69c95563-89eb-4c55-9cc4-4b42adbf7786",
"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-10-22T07:27:54.4036317+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3a609c14-3294-4721-aed0-47e87527f72c",
"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": "214b43dd-3445-495d-831d-fa7067a3ec19",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-22T07:27:54.420861+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "201e2964-c4cb-420c-8594-d91bbd734cea"
},
"suggested_date_start": "2026-10-22T07:27:54.420861+00:00",
"skill_id": "888b6d8e-380f-4db3-a9f0-39497e20eb05",
"skill_code": "sample string 32",
"skill": {
"id": "d95a937d-3866-4b00-87ba-cd9eb68d4b05",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ad978170-5b2b-4a91-8873-5bac90aecf10",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bf99cbc2-7463-4b0d-8d26-1e269a4c52c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4b61b4ca-75d5-4e12-8399-2e927f93ed7d",
"db_currency_id": "2d47da38-cc86-4dbe-9d6d-4756176ebecb",
"db_language_id": "69c95563-89eb-4c55-9cc4-4b42adbf7786",
"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-10-22T07:27:54.4036317+00:00"
},
"modified_dateutc": "2026-10-22T07:27:54.420861+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b7b5e5b4-dad0-4a75-8511-0383db1f95a9",
"date_reported_by_company": "2026-10-22T07:27:54.420861+00:00",
"id2": 36,
"company_id": "aa3b6388-7811-44f9-bdee-e4f75053ea61",
"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": "6db7755e-11e0-4903-b294-afab20ec2b7e",
"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-10-22T07:27:54.420861+00:00"
},
"work_instruction_details_id": "ed3ab916-c09e-4649-b35a-6c4f3d1261d5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "504c6e9d-d953-4703-b7a4-913eead56630",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ae862aed-e9e7-43b6-9489-68d19f0b3261",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-22T07:27:54.420861+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": "65939e77-29d8-4c0c-90de-94a5eead8764",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-22T07:27:54.420861+00:00"
}