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": "ce89bc4a-5e3e-47b7-945e-061a53ff4c09",
"jobs_id": "848ba41e-a9b8-4b97-a577-f20f7c3c43fd",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c35fe5af-fe9e-40b4-a576-903dff8150f5",
"_parent_id": "18a24eb3-672c-4569-9881-da737f634cf5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f9f1265c-6467-4e91-b1dc-729a71b3bc1d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "11bb8b2a-2f9e-4f94-87e5-ea5dbd8b8552",
"_parent_id": "e41954d6-210f-494e-8d65-41ff33def7a9",
"root_parent_id": "b59d73b1-f24b-4780-a6e7-76a8a7c6d69b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "19d1f4af-2321-4b97-85e5-96936a8b12f0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2e0466de-8bcf-47ef-a7fd-184d636dcabb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ab44e360-2227-455f-8ea4-69bd50ffa035",
"_parent_code": "sample string 6",
"sales_organization_id": "b2d02b40-0a6b-47fe-b956-f19618402d5e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1096757b-5eed-476e-861e-e76291526cbd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "223734d5-dab4-4775-99dd-76ad9e42d06a",
"db_currency_id": "419dc15a-676e-44b5-8f60-ee31eb77748c",
"db_language_id": "231efa55-786e-4d01-b6ce-7c8a0d275e5e",
"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-06-07T23:18:57.765644+00:00"
},
"modified_dateutc": "2025-06-07T23:18:57.765644+00:00"
},
"equipment_model_id": "28d0117f-0368-40c2-be3b-bb74ca127d45",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f8af7fd4-f107-4852-ba0b-ed40d121f842",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "fe4b542d-74d4-4f69-98bc-ad2f77c7f622",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "dc46bc09-edd6-4cc0-97d7-efa9a81bea00",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d90d0c74-d663-4124-bfa4-1a05effbfd8f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1096757b-5eed-476e-861e-e76291526cbd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "223734d5-dab4-4775-99dd-76ad9e42d06a",
"db_currency_id": "419dc15a-676e-44b5-8f60-ee31eb77748c",
"db_language_id": "231efa55-786e-4d01-b6ce-7c8a0d275e5e",
"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-06-07T23:18:57.765644+00:00"
},
"modified_dateutc": "2025-06-07T23:18:57.765644+00:00"
},
"equipment_family_id": "87ff0576-b537-4aac-bf81-295183a285d3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2e0466de-8bcf-47ef-a7fd-184d636dcabb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ab44e360-2227-455f-8ea4-69bd50ffa035",
"_parent_code": "sample string 6",
"sales_organization_id": "b2d02b40-0a6b-47fe-b956-f19618402d5e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1096757b-5eed-476e-861e-e76291526cbd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "223734d5-dab4-4775-99dd-76ad9e42d06a",
"db_currency_id": "419dc15a-676e-44b5-8f60-ee31eb77748c",
"db_language_id": "231efa55-786e-4d01-b6ce-7c8a0d275e5e",
"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-06-07T23:18:57.765644+00:00"
},
"modified_dateutc": "2025-06-07T23:18:57.765644+00:00"
},
"date_in_production_since": "2025-06-07T23:18:57.765644+00:00",
"date_out_of_production_since": "2025-06-07T23:18:57.765644+00:00",
"date_end_support": "2025-06-07T23:18:57.765644+00:00",
"sales_organization_id": "74c86bf8-210e-4c34-8e17-36007c7c28b3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1096757b-5eed-476e-861e-e76291526cbd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "223734d5-dab4-4775-99dd-76ad9e42d06a",
"db_currency_id": "419dc15a-676e-44b5-8f60-ee31eb77748c",
"db_language_id": "231efa55-786e-4d01-b6ce-7c8a0d275e5e",
"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-06-07T23:18:57.765644+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-06-07T23:18:57.765644+00:00"
},
"project_status_id": "fb418d97-40c2-4f99-bfa5-7e725778687e",
"project_status_code": "sample string 10",
"project_status": {
"id": "e797bae4-48d1-4956-8239-8030439cf24f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9dbcc899-9f93-40a6-9ed4-cf73e3025cab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1096757b-5eed-476e-861e-e76291526cbd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "223734d5-dab4-4775-99dd-76ad9e42d06a",
"db_currency_id": "419dc15a-676e-44b5-8f60-ee31eb77748c",
"db_language_id": "231efa55-786e-4d01-b6ce-7c8a0d275e5e",
"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-06-07T23:18:57.765644+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-07T23:18:57.765644+00:00"
},
"company_id": "b30e0c23-387f-436a-bc87-dc9fea169c3b",
"company_code": "sample string 12",
"db_address_id": "64bfea76-8626-4271-8cb2-4a42bb5d2c7b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "94f33740-2980-4d86-99d5-9bfec4aff848",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "775ea860-4b69-4da9-ae42-187700f548d2",
"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-06-07T23:18:57.765644+00:00",
"date_create": "2025-06-07T23:18:57.765644+00:00",
"date_update": "2025-06-07T23:18:57.765644+00:00",
"updated_by_user_id": "2b6a59bd-6644-4ceb-bc51-0f2a2a37023a",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-06-07T23:18:57.765644+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-06-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-06-07T23:18:57.765644+00:00",
"date_last_job": "2025-06-07T23:18:57.765644+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-06-07T23:18:57.765644+00:00",
"modified_dateutc": "2025-06-07T23:18:57.765644+00:00",
"is_mobile_installation": true
},
"job_type_id": "23c2da0a-8d13-475d-945c-f058a3ea8764",
"job_type_code": "sample string 7",
"job_type": {
"id": "d346859a-38d8-4ed3-96fe-5b8b7ffe02d7",
"name": "sample string 2",
"sales_organization_id": "8fbb99b6-79b5-4f3b-a29b-307ce1d86be5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-06-07T23:18:57.765644+00:00",
"code": "sample string 7"
},
"job_priority_id": "644a2d54-4d04-4297-94a3-3718fd4672b5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c53e3cdc-066a-4ee7-b75e-4fc4de7a5492",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5b1fe6ae-d04a-4d2d-84b8-8f2b272b6630",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1096757b-5eed-476e-861e-e76291526cbd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "223734d5-dab4-4775-99dd-76ad9e42d06a",
"db_currency_id": "419dc15a-676e-44b5-8f60-ee31eb77748c",
"db_language_id": "231efa55-786e-4d01-b6ce-7c8a0d275e5e",
"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-06-07T23:18:57.765644+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-07T23:18:57.765644+00:00"
},
"job_status_id": "01350be1-fd4b-4c2a-a2c4-2e78f2989fc3",
"job_status_code": "sample string 11",
"db_address_id": "91aff67d-653a-4599-9ecc-c9f96610035c",
"contact_id": "e697c553-a4ff-4c93-a409-609b3d731bd2",
"requested_by_company_id": "64416e6f-9f20-4551-9941-ad42d640dd95",
"requested_by_contact_id": "f49b4887-02b5-4b4e-8760-a52850a787bd",
"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-06-07T23:18:57.765644+00:00",
"due_date": "2025-06-07T23:18:57.765644+00:00",
"date_create": "2025-06-07T23:18:57.765644+00:00",
"date_update": "2025-06-07T23:18:57.765644+00:00",
"date_closed": "2025-06-07T23:18:57.765644+00:00",
"suggested_user_id": "37130757-159c-4ac2-93d0-a170eeb5cb92",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "69a94a2f-e542-4992-9922-0f822eddcab7",
"db_language_id": "4fd8185a-472a-4049-853b-d5fd68731091",
"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-06-07T23:18:57.765644+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dfa17338-aaee-4e82-b630-21392912a770",
"sales_organization": {
"id": "1096757b-5eed-476e-861e-e76291526cbd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "223734d5-dab4-4775-99dd-76ad9e42d06a",
"db_currency_id": "419dc15a-676e-44b5-8f60-ee31eb77748c",
"db_language_id": "231efa55-786e-4d01-b6ce-7c8a0d275e5e",
"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-06-07T23:18:57.765644+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b903b57a-2ad1-4f68-b220-46c69c624dac",
"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": "6a0efc54-e53d-440f-9a5b-704ddc77bf52",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-06-07T23:18:57.765644+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c7b3201a-38cb-4d9d-a10b-8a13e6d81f0c"
},
"suggested_date_start": "2025-06-07T23:18:57.765644+00:00",
"skill_id": "c24f202a-8597-428b-a0bd-9245aeaebc99",
"skill_code": "sample string 32",
"skill": {
"id": "9ed166e2-1b17-4667-b7ed-9cb36a6d2e95",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1e247c30-b5ec-4b49-a5c9-3881c7f9b0d8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1096757b-5eed-476e-861e-e76291526cbd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "223734d5-dab4-4775-99dd-76ad9e42d06a",
"db_currency_id": "419dc15a-676e-44b5-8f60-ee31eb77748c",
"db_language_id": "231efa55-786e-4d01-b6ce-7c8a0d275e5e",
"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-06-07T23:18:57.765644+00:00"
},
"modified_dateutc": "2025-06-07T23:18:57.765644+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f6f546eb-e1df-43e6-8692-9cf8f47de07b",
"date_reported_by_company": "2025-06-07T23:18:57.765644+00:00",
"id2": 36,
"company_id": "3d252a21-ded7-487e-a52d-0f4085cef885",
"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": "d8fb73f7-0738-4210-b364-a4e30fc9a4d7",
"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-06-07T23:18:57.765644+00:00"
},
"work_instruction_details_id": "64d849cf-aedd-4a44-8ad6-6e6248ee9809",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "da845f1d-94a3-4479-9993-5573f7185c20",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2dd93230-8d66-4cca-ad83-a6951ed52fba",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-06-07T23:18:57.765644+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": "4e5e4b5c-d94a-4447-a741-abad56046369",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-06-07T23:18:57.7812719+00:00"
}