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": "87a9d542-4df3-4711-9d4f-bf12dd03d535",
"jobs_id": "22b06d25-334f-4f9a-aaf6-de366f123e16",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9dd1a39a-f855-4993-a029-da3d18aa0b4c",
"_parent_id": "44df0a6d-c7fe-4542-8d2a-09431b8bdc0d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6a9e6f69-c615-468a-b92b-310d0293c6c0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "bdc1273c-f26e-4106-bd22-64338b6bc7b1",
"_parent_id": "2ce80b32-edbc-4ff6-a570-7c51d2c26563",
"root_parent_id": "7bbabbca-2e61-4892-962b-ecc8abe06466",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5e1726d0-b5b9-4108-9f6e-3a3429041b96",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "971bcf6a-f05e-4457-829f-79c77b240224",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1b248868-024a-4685-a823-e77a57267d0e",
"_parent_code": "sample string 6",
"sales_organization_id": "b823ff8d-f989-40f2-9e98-e1c8992c6481",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8f533b29-9d87-4e18-8f4d-8238c1b46440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e55f133-60ec-479e-a357-2bda140b8937",
"db_currency_id": "1ff4f5b7-8f11-473d-a5c7-f32f896f7442",
"db_language_id": "ff49043b-88ad-4660-9ce8-b6f290987176",
"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-08-21T21:43:38.1937491+00:00"
},
"modified_dateutc": "2026-08-21T21:43:38.1937491+00:00"
},
"equipment_model_id": "54126749-d443-4f24-ad4f-9213202b16a9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d0e3239b-cc4b-4492-aae6-bbe613723e20",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3b60a30a-0fb3-4a15-b38a-f715f5a04828",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0c7edd68-86de-4208-a0d8-5579b5e01e09",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "95cb14b8-149d-4492-b899-5f321a4a7653",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8f533b29-9d87-4e18-8f4d-8238c1b46440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e55f133-60ec-479e-a357-2bda140b8937",
"db_currency_id": "1ff4f5b7-8f11-473d-a5c7-f32f896f7442",
"db_language_id": "ff49043b-88ad-4660-9ce8-b6f290987176",
"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-08-21T21:43:38.1937491+00:00"
},
"modified_dateutc": "2026-08-21T21:43:38.1937491+00:00"
},
"equipment_family_id": "e299433b-cdc6-4000-bf40-9ef09b4b6f7e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "971bcf6a-f05e-4457-829f-79c77b240224",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1b248868-024a-4685-a823-e77a57267d0e",
"_parent_code": "sample string 6",
"sales_organization_id": "b823ff8d-f989-40f2-9e98-e1c8992c6481",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8f533b29-9d87-4e18-8f4d-8238c1b46440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e55f133-60ec-479e-a357-2bda140b8937",
"db_currency_id": "1ff4f5b7-8f11-473d-a5c7-f32f896f7442",
"db_language_id": "ff49043b-88ad-4660-9ce8-b6f290987176",
"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-08-21T21:43:38.1937491+00:00"
},
"modified_dateutc": "2026-08-21T21:43:38.1937491+00:00"
},
"date_in_production_since": "2026-08-21T21:43:38.1937491+00:00",
"date_out_of_production_since": "2026-08-21T21:43:38.1937491+00:00",
"date_end_support": "2026-08-21T21:43:38.1937491+00:00",
"sales_organization_id": "1a4cb418-234a-4c20-be40-959899f5d055",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8f533b29-9d87-4e18-8f4d-8238c1b46440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e55f133-60ec-479e-a357-2bda140b8937",
"db_currency_id": "1ff4f5b7-8f11-473d-a5c7-f32f896f7442",
"db_language_id": "ff49043b-88ad-4660-9ce8-b6f290987176",
"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-08-21T21:43:38.1937491+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-08-21T21:43:38.1937491+00:00"
},
"project_status_id": "945ff444-1947-446c-b4d3-4bf46d59959f",
"project_status_code": "sample string 10",
"project_status": {
"id": "a5af03ce-e662-441c-a4a4-328492ebb895",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4bab7a39-e1eb-4c93-b889-dab64c52f7d5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8f533b29-9d87-4e18-8f4d-8238c1b46440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e55f133-60ec-479e-a357-2bda140b8937",
"db_currency_id": "1ff4f5b7-8f11-473d-a5c7-f32f896f7442",
"db_language_id": "ff49043b-88ad-4660-9ce8-b6f290987176",
"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-08-21T21:43:38.1937491+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-21T21:43:38.1937491+00:00"
},
"company_id": "c8edfa77-710f-497c-adb9-1d33ef8b1c0d",
"company_code": "sample string 12",
"db_address_id": "fc848871-32a9-4902-809d-49a570c57fa7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "180c2aa2-a74a-4516-9bbe-6ae2d5f8da2d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4c758f32-3440-493a-84b3-483dfc5c4ca3",
"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-08-21T21:43:38.1937491+00:00",
"date_create": "2026-08-21T21:43:38.1937491+00:00",
"date_update": "2026-08-21T21:43:38.1937491+00:00",
"updated_by_user_id": "65992c45-f638-4f3c-9b94-c596dc31f71b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-21T21:43:38.1937491+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-08-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-21T21:43:38.1937491+00:00",
"date_last_job": "2026-08-21T21:43:38.1937491+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-21T21:43:38.1937491+00:00",
"modified_dateutc": "2026-08-21T21:43:38.1937491+00:00",
"is_mobile_installation": true
},
"job_type_id": "c18a3960-609e-4f83-80aa-4f64659cd52d",
"job_type_code": "sample string 7",
"job_type": {
"id": "497bc0d8-5d65-4038-98e3-329a71efc3e1",
"name": "sample string 2",
"sales_organization_id": "8fd40a1d-9121-4477-97d1-9e18a1e5859b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-21T21:43:38.1937491+00:00",
"code": "sample string 7"
},
"job_priority_id": "8cdbbf26-46a6-4a01-9521-143962e7f4c1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "37a226e2-01ec-4915-ad63-5daa8f1449e6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "71ee3aab-1654-4da8-b7df-e03d14ea3409",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8f533b29-9d87-4e18-8f4d-8238c1b46440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e55f133-60ec-479e-a357-2bda140b8937",
"db_currency_id": "1ff4f5b7-8f11-473d-a5c7-f32f896f7442",
"db_language_id": "ff49043b-88ad-4660-9ce8-b6f290987176",
"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-08-21T21:43:38.1937491+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-21T21:43:38.1937491+00:00"
},
"job_status_id": "230246a7-580a-46c1-b68d-c6bca0b337e7",
"job_status_code": "sample string 11",
"db_address_id": "8fa1e66a-e0bb-4a4e-8a4a-5eeb4ed81890",
"contact_id": "47099ab4-1e5e-424c-a4d1-3ed32ef24119",
"requested_by_company_id": "a4535c65-f4c8-4bc1-b263-81ae7ac93bea",
"requested_by_contact_id": "9e55eec1-e31e-4d48-ac20-e3e21c692b9d",
"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-08-21T21:43:38.1937491+00:00",
"due_date": "2026-08-21T21:43:38.1937491+00:00",
"date_create": "2026-08-21T21:43:38.1937491+00:00",
"date_update": "2026-08-21T21:43:38.1937491+00:00",
"date_closed": "2026-08-21T21:43:38.1937491+00:00",
"suggested_user_id": "f3a75ef9-53f8-47fa-8055-040b98d0b48c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "be98f437-6ddc-4e9a-9d5f-a86bac2b398e",
"db_language_id": "8b889a23-35f7-41ac-a2f7-983cee6b4988",
"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-08-21T21:43:38.1937491+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "68283e20-9f77-4887-96f7-6e89d4ba9057",
"sales_organization": {
"id": "8f533b29-9d87-4e18-8f4d-8238c1b46440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e55f133-60ec-479e-a357-2bda140b8937",
"db_currency_id": "1ff4f5b7-8f11-473d-a5c7-f32f896f7442",
"db_language_id": "ff49043b-88ad-4660-9ce8-b6f290987176",
"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-08-21T21:43:38.1937491+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "16422106-3cef-4652-b940-4ec9bd25fb05",
"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": "acd82011-2dd2-413e-839d-1c8e169c8996",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-21T21:43:38.1937491+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2a3e7115-b3c2-4cd2-ba4e-eb5a6182e61a"
},
"suggested_date_start": "2026-08-21T21:43:38.1937491+00:00",
"skill_id": "37901b84-71e9-4aae-bf11-390a15d3cc83",
"skill_code": "sample string 32",
"skill": {
"id": "a7c4f434-cfe6-4da3-b71f-295a70c25c38",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "520bfbc3-1b92-4437-9a39-ced4f543c7e6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8f533b29-9d87-4e18-8f4d-8238c1b46440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3e55f133-60ec-479e-a357-2bda140b8937",
"db_currency_id": "1ff4f5b7-8f11-473d-a5c7-f32f896f7442",
"db_language_id": "ff49043b-88ad-4660-9ce8-b6f290987176",
"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-08-21T21:43:38.1937491+00:00"
},
"modified_dateutc": "2026-08-21T21:43:38.1937491+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1e859af5-ad5b-406d-9ae9-1a8b304236be",
"date_reported_by_company": "2026-08-21T21:43:38.1937491+00:00",
"id2": 36,
"company_id": "ca89380c-f37e-469b-816a-8da77f693c24",
"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": "df830ce9-af2c-4bc2-8da6-ba301aff0c25",
"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-08-21T21:43:38.1937491+00:00"
},
"work_instruction_details_id": "7329cf5a-3606-4719-b90a-9f4e51e369b5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bd1c4e95-96a4-4119-afcf-57f3457b1b0e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "060e089b-ff94-4e5b-97f0-2fec12e03f46",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-21T21:43:38.1937491+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": "ffd53c6b-d4f0-4792-bdfb-31c699859dd7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-21T21:43:38.1937491+00:00"
}