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": "7a91c4be-0a62-4e68-9b20-5c4f7cfab228",
"jobs_id": "5530b1d2-2843-4b26-b00c-8ba35b8aaa20",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5e22c419-3d50-4421-be8e-22cc13aefec7",
"_parent_id": "44a0a664-fb4d-4933-8ffb-f614c316650e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "14ae1059-754f-42d2-83a6-377add661fb7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5c994c2f-dda1-4ddf-8441-043ae523eb00",
"_parent_id": "f1e332ce-4830-4b11-91fb-d84d92fa3f10",
"root_parent_id": "024d4fd1-8f51-4c27-a0b8-25dc79c0cb83",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ac44992a-47ec-43ca-b88d-3aa83346a1cb",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a2730457-94d5-462e-96b3-81f4a57a31dd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0f3b7ceb-8df2-40e9-a7c8-643cd06b647c",
"_parent_code": "sample string 6",
"sales_organization_id": "5d5591a6-3e48-411a-9cbd-d80a375d3afa",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "47e3a436-f7ea-4bfc-ba18-a88b9eb1d0a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94a7549b-7169-4ced-b46d-004d480a408c",
"db_currency_id": "e4382f79-09e0-4f82-af05-1346bad49e0a",
"db_language_id": "48517da7-285a-4c03-85c8-74b1cae05c62",
"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-18T17:25:35.1174207+00:00"
},
"modified_dateutc": "2026-08-18T17:25:35.1174207+00:00"
},
"equipment_model_id": "9d038b10-2bf1-4479-ae95-d2bc2dbf58f6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9715ac80-d0d0-4252-8158-cd4ce753c0a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "bdeff58a-817f-4201-963e-e713ea6f460c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "96731ac3-213a-4cb7-b2e2-91164119c63d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e60973df-1197-4a4d-875e-e99c5f7845a7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "47e3a436-f7ea-4bfc-ba18-a88b9eb1d0a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94a7549b-7169-4ced-b46d-004d480a408c",
"db_currency_id": "e4382f79-09e0-4f82-af05-1346bad49e0a",
"db_language_id": "48517da7-285a-4c03-85c8-74b1cae05c62",
"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-18T17:25:35.1174207+00:00"
},
"modified_dateutc": "2026-08-18T17:25:35.1174207+00:00"
},
"equipment_family_id": "c96c6cda-5a9e-41e1-add3-48e5e8e359a5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a2730457-94d5-462e-96b3-81f4a57a31dd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0f3b7ceb-8df2-40e9-a7c8-643cd06b647c",
"_parent_code": "sample string 6",
"sales_organization_id": "5d5591a6-3e48-411a-9cbd-d80a375d3afa",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "47e3a436-f7ea-4bfc-ba18-a88b9eb1d0a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94a7549b-7169-4ced-b46d-004d480a408c",
"db_currency_id": "e4382f79-09e0-4f82-af05-1346bad49e0a",
"db_language_id": "48517da7-285a-4c03-85c8-74b1cae05c62",
"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-18T17:25:35.1174207+00:00"
},
"modified_dateutc": "2026-08-18T17:25:35.1174207+00:00"
},
"date_in_production_since": "2026-08-18T17:25:35.1174207+00:00",
"date_out_of_production_since": "2026-08-18T17:25:35.1174207+00:00",
"date_end_support": "2026-08-18T17:25:35.1174207+00:00",
"sales_organization_id": "219cf71f-ac65-44e5-8427-7e84049ea968",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "47e3a436-f7ea-4bfc-ba18-a88b9eb1d0a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94a7549b-7169-4ced-b46d-004d480a408c",
"db_currency_id": "e4382f79-09e0-4f82-af05-1346bad49e0a",
"db_language_id": "48517da7-285a-4c03-85c8-74b1cae05c62",
"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-18T17:25:35.1174207+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-18T17:25:35.1174207+00:00"
},
"project_status_id": "216b8bf6-88bf-45fc-8598-e336e9233fe1",
"project_status_code": "sample string 10",
"project_status": {
"id": "eecb3647-f6af-4dd5-ade7-56e1046be06c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "938758f4-0283-417c-ad38-aa34b6e72ab4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "47e3a436-f7ea-4bfc-ba18-a88b9eb1d0a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94a7549b-7169-4ced-b46d-004d480a408c",
"db_currency_id": "e4382f79-09e0-4f82-af05-1346bad49e0a",
"db_language_id": "48517da7-285a-4c03-85c8-74b1cae05c62",
"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-18T17:25:35.1174207+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-18T17:25:35.1174207+00:00"
},
"company_id": "6239b4bf-df66-4c9f-9bb9-ce292b914b26",
"company_code": "sample string 12",
"db_address_id": "5a3f2e69-e127-4253-9317-a1bb48443aae",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6584a91e-0d85-4dc4-a290-94b148b617b5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "76e047c3-6113-48a5-a189-0e6ec3b99275",
"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-18T17:25:35.1174207+00:00",
"date_create": "2026-08-18T17:25:35.1174207+00:00",
"date_update": "2026-08-18T17:25:35.1174207+00:00",
"updated_by_user_id": "193a2e80-d6e8-453b-b439-689dda161970",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-18T17:25:35.1174207+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-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-18T17:25:35.1174207+00:00",
"date_last_job": "2026-08-18T17:25:35.1174207+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-18T17:25:35.1174207+00:00",
"modified_dateutc": "2026-08-18T17:25:35.1174207+00:00",
"is_mobile_installation": true
},
"job_type_id": "8b37bafe-a895-485f-9980-e115f05520b8",
"job_type_code": "sample string 7",
"job_type": {
"id": "0cacbb0c-8f08-4f3b-b871-3bcb1906a201",
"name": "sample string 2",
"sales_organization_id": "984326ad-1945-431e-bc29-365bd1c7fdaa",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-18T17:25:35.1174207+00:00",
"code": "sample string 7"
},
"job_priority_id": "3c3b3e58-02cb-48b3-a3c0-9a61170132ec",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ee059996-b5ea-4c5c-9f5c-2a59cb0a5ce6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ead95917-d0b6-45d0-8bb7-bfbd0b2abaa8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "47e3a436-f7ea-4bfc-ba18-a88b9eb1d0a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94a7549b-7169-4ced-b46d-004d480a408c",
"db_currency_id": "e4382f79-09e0-4f82-af05-1346bad49e0a",
"db_language_id": "48517da7-285a-4c03-85c8-74b1cae05c62",
"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-18T17:25:35.1174207+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-18T17:25:35.1174207+00:00"
},
"job_status_id": "961776a4-d0ce-4d1c-8396-89e82d982b81",
"job_status_code": "sample string 11",
"db_address_id": "43851fed-629d-4eea-bc3a-04d0ee855c05",
"contact_id": "b977b2e2-3461-4eca-9b07-3f4fb16cb8fa",
"requested_by_company_id": "2b49ec01-6c15-47d5-8f43-3b0553eada6a",
"requested_by_contact_id": "a934ec52-e8e2-4a5d-9e64-03f37be2777b",
"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-18T17:25:35.1174207+00:00",
"due_date": "2026-08-18T17:25:35.1174207+00:00",
"date_create": "2026-08-18T17:25:35.1174207+00:00",
"date_update": "2026-08-18T17:25:35.1174207+00:00",
"date_closed": "2026-08-18T17:25:35.1174207+00:00",
"suggested_user_id": "52741814-ae02-4853-89fe-9e88138c7b4f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3a112c0d-3b60-495c-8ec0-93c3eb31c003",
"db_language_id": "5c542d7c-b429-49e9-83bd-fce653e20d96",
"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-18T17:25:35.1174207+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2c8be8d5-697e-4173-a2a9-dd5eccfacaa8",
"sales_organization": {
"id": "47e3a436-f7ea-4bfc-ba18-a88b9eb1d0a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94a7549b-7169-4ced-b46d-004d480a408c",
"db_currency_id": "e4382f79-09e0-4f82-af05-1346bad49e0a",
"db_language_id": "48517da7-285a-4c03-85c8-74b1cae05c62",
"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-18T17:25:35.1174207+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3f9b11b2-b1d3-4e16-b236-4b77f7297ba0",
"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": "4531eeec-984f-420a-9a9a-1cae977f41af",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-18T17:25:35.1174207+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "e3e7ea1d-c831-4640-a960-ea3b9a8b8002"
},
"suggested_date_start": "2026-08-18T17:25:35.1174207+00:00",
"skill_id": "b1e6c41b-96e8-4d7d-af63-32a524879941",
"skill_code": "sample string 32",
"skill": {
"id": "5addfbb1-cdb3-44f1-b330-ba2dfa65785c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c3cf23e8-c998-4f5b-b544-9bed3e250e5a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "47e3a436-f7ea-4bfc-ba18-a88b9eb1d0a7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94a7549b-7169-4ced-b46d-004d480a408c",
"db_currency_id": "e4382f79-09e0-4f82-af05-1346bad49e0a",
"db_language_id": "48517da7-285a-4c03-85c8-74b1cae05c62",
"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-18T17:25:35.1174207+00:00"
},
"modified_dateutc": "2026-08-18T17:25:35.1174207+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d0a1df24-6678-438b-b5a0-1ca41b6aaa4d",
"date_reported_by_company": "2026-08-18T17:25:35.1174207+00:00",
"id2": 36,
"company_id": "43a1b8ec-67f9-4f51-a8ca-452468efc448",
"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": "738dec47-c5c8-4cbc-b129-094d8ea9fe23",
"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-18T17:25:35.1174207+00:00"
},
"work_instruction_details_id": "d1bc095f-556d-4c33-9629-e25f4146a91d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9b0aeaa6-b53c-4899-be7d-42797cb74219",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4595668b-da3f-4466-99af-dce9e9b6ab44",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-18T17:25:35.1174207+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": "81eef226-601f-4d90-ac55-80c937fded89",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-18T17:25:35.1174207+00:00"
}