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": "1b0ac2d1-e2e9-40df-b27a-10fdd055650e",
"jobs_id": "ab4a960e-1180-4cd0-96ac-a3a12edaeafa",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d3d0cf72-36cc-4944-ac38-a58605f3cfb0",
"_parent_id": "f2a3739b-4eb7-41b1-bbb0-4ed6cdae7fd3",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f7a0e46d-0cea-4cd1-be24-ce86ac0e3694",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a46083d5-79ae-4f75-b7d3-04933331aae7",
"_parent_id": "6a1778fd-bd7a-4b63-bf97-abda540153d5",
"root_parent_id": "74f5d783-d267-410e-97ce-937054f3f84b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "73f7deaf-86ae-4150-acda-8e2381b7d9dc",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4ef14695-e18e-4cc9-a049-502f2398c6d7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9152d8bb-2c27-4ec3-9d8c-314d5e84f558",
"_parent_code": "sample string 6",
"sales_organization_id": "bb86cd2e-db18-47fb-b220-0d78fb2718ab",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "92518d49-4531-4bf1-aca2-90d18eea34d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6d9e286-8361-4e5d-8192-e1b57bdfd8ae",
"db_currency_id": "716bcfa4-d1b6-43b4-9bec-6d15dcf2e9df",
"db_language_id": "579d127a-cbbc-4a6d-853c-fdee2363b0a8",
"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": "2025-11-30T06:48:23.9930003+00:00"
},
"modified_dateutc": "2025-11-30T06:48:23.9930003+00:00"
},
"equipment_model_id": "1e6ddb7f-e1a6-4ba0-a0d4-5dd92e1b0962",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a63e0d7c-413f-442e-8f60-a02a424eb383",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "023a7379-3203-4aba-8ab8-e2850effc497",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "37cf7354-0ebb-45fb-9097-f9b9c0a502c0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9edb45ca-2535-48a6-b86a-085f73cca1a9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "92518d49-4531-4bf1-aca2-90d18eea34d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6d9e286-8361-4e5d-8192-e1b57bdfd8ae",
"db_currency_id": "716bcfa4-d1b6-43b4-9bec-6d15dcf2e9df",
"db_language_id": "579d127a-cbbc-4a6d-853c-fdee2363b0a8",
"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": "2025-11-30T06:48:23.9930003+00:00"
},
"modified_dateutc": "2025-11-30T06:48:24.0086255+00:00"
},
"equipment_family_id": "23d1684a-f611-4697-85e0-849f32f1ba60",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4ef14695-e18e-4cc9-a049-502f2398c6d7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9152d8bb-2c27-4ec3-9d8c-314d5e84f558",
"_parent_code": "sample string 6",
"sales_organization_id": "bb86cd2e-db18-47fb-b220-0d78fb2718ab",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "92518d49-4531-4bf1-aca2-90d18eea34d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6d9e286-8361-4e5d-8192-e1b57bdfd8ae",
"db_currency_id": "716bcfa4-d1b6-43b4-9bec-6d15dcf2e9df",
"db_language_id": "579d127a-cbbc-4a6d-853c-fdee2363b0a8",
"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": "2025-11-30T06:48:23.9930003+00:00"
},
"modified_dateutc": "2025-11-30T06:48:23.9930003+00:00"
},
"date_in_production_since": "2025-11-30T06:48:24.0086255+00:00",
"date_out_of_production_since": "2025-11-30T06:48:24.0086255+00:00",
"date_end_support": "2025-11-30T06:48:24.0086255+00:00",
"sales_organization_id": "b1804d74-2008-4d8e-8ebc-b0f4e0de8941",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "92518d49-4531-4bf1-aca2-90d18eea34d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6d9e286-8361-4e5d-8192-e1b57bdfd8ae",
"db_currency_id": "716bcfa4-d1b6-43b4-9bec-6d15dcf2e9df",
"db_language_id": "579d127a-cbbc-4a6d-853c-fdee2363b0a8",
"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": "2025-11-30T06:48:23.9930003+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": "2025-11-30T06:48:24.0086255+00:00"
},
"project_status_id": "f6834dc7-4e60-4f54-a29b-0a30ae872417",
"project_status_code": "sample string 10",
"project_status": {
"id": "62567a6f-173b-4d9d-8aad-0f01f4173055",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d6026fcc-0b40-4edf-a81d-bd98b119e231",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "92518d49-4531-4bf1-aca2-90d18eea34d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6d9e286-8361-4e5d-8192-e1b57bdfd8ae",
"db_currency_id": "716bcfa4-d1b6-43b4-9bec-6d15dcf2e9df",
"db_language_id": "579d127a-cbbc-4a6d-853c-fdee2363b0a8",
"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": "2025-11-30T06:48:23.9930003+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-30T06:48:24.0086255+00:00"
},
"company_id": "e53aa1a1-416d-4192-b95e-901304d62ef6",
"company_code": "sample string 12",
"db_address_id": "59aeb5df-a259-4bc6-923b-ee784eeb8778",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9019c06f-ea2e-48b9-9873-879fa6fd35f4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "528d0267-46ef-4153-b82a-5a932a1f10db",
"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": "2025-11-30T06:48:24.0086255+00:00",
"date_create": "2025-11-30T06:48:24.0086255+00:00",
"date_update": "2025-11-30T06:48:24.0086255+00:00",
"updated_by_user_id": "b1ed3d4b-211c-471c-ba37-476b1f3ec456",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-30T06:48:24.0086255+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": "2025-11-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-30T06:48:24.0086255+00:00",
"date_last_job": "2025-11-30T06:48:24.0086255+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-30T06:48:24.0086255+00:00",
"modified_dateutc": "2025-11-30T06:48:24.0086255+00:00",
"is_mobile_installation": true
},
"job_type_id": "18a96fbe-110b-4d00-9a12-ce3ea58bc8c2",
"job_type_code": "sample string 7",
"job_type": {
"id": "1788d350-0edb-4bff-bb5c-5b892286419a",
"name": "sample string 2",
"sales_organization_id": "2a4c78c0-8bc6-41e3-8a0a-4abbef0b9a0f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-30T06:48:24.0086255+00:00",
"code": "sample string 7"
},
"job_priority_id": "4719f8fe-9429-4e29-9d96-b68a3d152925",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "cfdf8502-9787-4698-9e4a-03c06da7e0f6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0e7db858-4653-47e3-9a59-48926623fe60",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "92518d49-4531-4bf1-aca2-90d18eea34d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6d9e286-8361-4e5d-8192-e1b57bdfd8ae",
"db_currency_id": "716bcfa4-d1b6-43b4-9bec-6d15dcf2e9df",
"db_language_id": "579d127a-cbbc-4a6d-853c-fdee2363b0a8",
"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": "2025-11-30T06:48:23.9930003+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-30T06:48:24.0086255+00:00"
},
"job_status_id": "25c68a2a-0bcc-47b3-b0bb-440e13715254",
"job_status_code": "sample string 11",
"db_address_id": "7e962262-7712-4c2e-891f-7e78045c6c9a",
"contact_id": "f7b23993-4d24-4a82-b3c3-669a55bb9eec",
"requested_by_company_id": "de8c52f5-bf74-4849-b20d-97ab62d4db99",
"requested_by_contact_id": "de0e5598-3215-4d8e-bc3d-b7948951fe37",
"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": "2025-11-30T06:48:24.0086255+00:00",
"due_date": "2025-11-30T06:48:24.0086255+00:00",
"date_create": "2025-11-30T06:48:24.0086255+00:00",
"date_update": "2025-11-30T06:48:24.0086255+00:00",
"date_closed": "2025-11-30T06:48:24.0086255+00:00",
"suggested_user_id": "b9aabd3b-af97-465d-b661-6552fda4c4a7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e9601036-98ef-4fb3-a363-85758d7b252f",
"db_language_id": "c3cc0ed9-ee6f-4c57-86a1-465cc25d7916",
"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": "2025-11-30T06:48:24.0086255+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6f11bd83-7b87-4643-aba2-232b6f5e7c0c",
"sales_organization": {
"id": "92518d49-4531-4bf1-aca2-90d18eea34d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6d9e286-8361-4e5d-8192-e1b57bdfd8ae",
"db_currency_id": "716bcfa4-d1b6-43b4-9bec-6d15dcf2e9df",
"db_language_id": "579d127a-cbbc-4a6d-853c-fdee2363b0a8",
"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": "2025-11-30T06:48:23.9930003+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2573f63c-8545-46f8-a66b-425388b03b92",
"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": "891163fd-8c96-4272-91b4-eab1c912e733",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-30T06:48:24.0086255+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "95f95081-fc9e-4da7-8344-4be8af08d457"
},
"suggested_date_start": "2025-11-30T06:48:24.0086255+00:00",
"skill_id": "b639f378-e88b-4a24-9be0-e03b53062afb",
"skill_code": "sample string 32",
"skill": {
"id": "3a76c95a-39f0-4e5f-bc51-9206b032d901",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "afc89b0d-b19b-4e3a-ad8e-e8ceac3fc5ee",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "92518d49-4531-4bf1-aca2-90d18eea34d5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6d9e286-8361-4e5d-8192-e1b57bdfd8ae",
"db_currency_id": "716bcfa4-d1b6-43b4-9bec-6d15dcf2e9df",
"db_language_id": "579d127a-cbbc-4a6d-853c-fdee2363b0a8",
"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": "2025-11-30T06:48:23.9930003+00:00"
},
"modified_dateutc": "2025-11-30T06:48:24.0086255+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "11e76484-8069-4a7a-8c8a-09ede008cf1d",
"date_reported_by_company": "2025-11-30T06:48:24.0086255+00:00",
"id2": 36,
"company_id": "b2f7f06c-0a2c-4c71-9f68-26ea24728318",
"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": "8abec75a-ca2e-4bf1-aa38-857ffa15d433",
"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": "2025-11-30T06:48:24.0086255+00:00"
},
"work_instruction_details_id": "3528137f-f2d6-4d70-9080-79d5851928f3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "095a6de5-0686-48ec-b027-f6f9dbf99902",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6ab5dd3f-ba8b-409d-8c53-bad0ce212805",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-30T06:48:24.0086255+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": "bd2eb999-297a-40ad-a89a-3718a8b0ef63",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-30T06:48:24.0242512+00:00"
}