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": "ea8f7a0f-52f4-4570-89af-a1c97c519d0b",
"jobs_id": "02f4edf2-6470-4307-959b-ac927fe7437d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7a1d96a2-4f9f-486d-9b65-2f5888bae530",
"_parent_id": "32636431-4c13-4cab-a7c7-fcb67fc82f80",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4b793b44-b0c8-4d38-ba93-471f578dda09",
"project_reference_back_office": "sample string 5",
"project": {
"id": "18684487-137a-4186-9108-8dd877649e39",
"_parent_id": "0a39b95b-d9a3-4dd6-a078-031c0cd2aa46",
"root_parent_id": "db0f3dfa-a2e8-46e4-9bab-26462066744f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "bb217cbe-5102-4f5e-881a-c2c18cb52831",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "328cdc75-c303-44f6-a92d-1313f8c983c4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d8e96bb8-98c9-4e17-87e3-ea38baaf1b5f",
"_parent_code": "sample string 6",
"sales_organization_id": "5098be31-c1a6-42a3-980d-b3c904a36fcc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7e414b15-8083-4de5-aab2-747af6029ecf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e69bdae3-e0e1-4ac5-9442-6ac9601bac4b",
"db_currency_id": "9dfecbc3-c868-41cc-bf89-2506fa9c5549",
"db_language_id": "08b0eec0-949d-4629-99b6-e5ba094fb480",
"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-07-07T01:25:21.5759312+00:00"
},
"modified_dateutc": "2026-07-07T01:25:21.5759312+00:00"
},
"equipment_model_id": "1ab5c656-e292-47b4-9c0f-a4383d0d99fa",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "54f23fe1-7826-479a-b3b9-b6e0a6d46907",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2b297204-d7e8-4ff2-801b-0fadb4b29cc9",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "51e8c8d2-d179-4562-8869-cfc64bc48efc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "48414ac1-3305-4d7c-8803-e378d58a5413",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7e414b15-8083-4de5-aab2-747af6029ecf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e69bdae3-e0e1-4ac5-9442-6ac9601bac4b",
"db_currency_id": "9dfecbc3-c868-41cc-bf89-2506fa9c5549",
"db_language_id": "08b0eec0-949d-4629-99b6-e5ba094fb480",
"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-07-07T01:25:21.5759312+00:00"
},
"modified_dateutc": "2026-07-07T01:25:21.5759312+00:00"
},
"equipment_family_id": "13d928f3-ada4-4e5f-9a01-f1607ffba972",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "328cdc75-c303-44f6-a92d-1313f8c983c4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d8e96bb8-98c9-4e17-87e3-ea38baaf1b5f",
"_parent_code": "sample string 6",
"sales_organization_id": "5098be31-c1a6-42a3-980d-b3c904a36fcc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7e414b15-8083-4de5-aab2-747af6029ecf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e69bdae3-e0e1-4ac5-9442-6ac9601bac4b",
"db_currency_id": "9dfecbc3-c868-41cc-bf89-2506fa9c5549",
"db_language_id": "08b0eec0-949d-4629-99b6-e5ba094fb480",
"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-07-07T01:25:21.5759312+00:00"
},
"modified_dateutc": "2026-07-07T01:25:21.5759312+00:00"
},
"date_in_production_since": "2026-07-07T01:25:21.5759312+00:00",
"date_out_of_production_since": "2026-07-07T01:25:21.5759312+00:00",
"date_end_support": "2026-07-07T01:25:21.5759312+00:00",
"sales_organization_id": "1dbbad5a-f755-4140-9060-85f5ef78e0e5",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7e414b15-8083-4de5-aab2-747af6029ecf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e69bdae3-e0e1-4ac5-9442-6ac9601bac4b",
"db_currency_id": "9dfecbc3-c868-41cc-bf89-2506fa9c5549",
"db_language_id": "08b0eec0-949d-4629-99b6-e5ba094fb480",
"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-07-07T01:25:21.5759312+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-07-07T01:25:21.5759312+00:00"
},
"project_status_id": "07514ba5-06ee-4c8d-8fa6-f7713ae776bc",
"project_status_code": "sample string 10",
"project_status": {
"id": "98e1f297-386d-4c79-8d17-4a926e38c496",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "935792e0-f7d3-4710-b8cc-10c57e881ad0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7e414b15-8083-4de5-aab2-747af6029ecf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e69bdae3-e0e1-4ac5-9442-6ac9601bac4b",
"db_currency_id": "9dfecbc3-c868-41cc-bf89-2506fa9c5549",
"db_language_id": "08b0eec0-949d-4629-99b6-e5ba094fb480",
"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-07-07T01:25:21.5759312+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-07T01:25:21.5759312+00:00"
},
"company_id": "b51a8e28-5f5a-4bc2-8dc2-d9a33d065dcc",
"company_code": "sample string 12",
"db_address_id": "8985876e-3ba2-42eb-aaa6-b95fc5977367",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "24d8e8c6-2971-43d8-b184-42a89f679295",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0ce30f2a-6bba-4fc6-867a-b2204af5cade",
"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-07-07T01:25:21.5759312+00:00",
"date_create": "2026-07-07T01:25:21.5759312+00:00",
"date_update": "2026-07-07T01:25:21.5759312+00:00",
"updated_by_user_id": "9ff935c4-09eb-4b1d-880d-4ac6f8f74743",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-07T01:25:21.5759312+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-07-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-07T01:25:21.5759312+00:00",
"date_last_job": "2026-07-07T01:25:21.5759312+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-07T01:25:21.5759312+00:00",
"modified_dateutc": "2026-07-07T01:25:21.5759312+00:00",
"is_mobile_installation": true
},
"job_type_id": "ff451572-a77d-4eb8-95b0-f4b624e738c8",
"job_type_code": "sample string 7",
"job_type": {
"id": "0e76de30-10fc-432d-a561-ae2ce5ab492e",
"name": "sample string 2",
"sales_organization_id": "3a999ece-7c7e-41f1-9cf5-338bbe037f3a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-07T01:25:21.5759312+00:00",
"code": "sample string 7"
},
"job_priority_id": "7be3a4d6-703f-4adb-b1d8-6a66fcdaf991",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0b6fced2-88da-46bf-a931-58aef978560e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1ec07a44-dee1-455e-94b8-b7d8a4c0df95",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7e414b15-8083-4de5-aab2-747af6029ecf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e69bdae3-e0e1-4ac5-9442-6ac9601bac4b",
"db_currency_id": "9dfecbc3-c868-41cc-bf89-2506fa9c5549",
"db_language_id": "08b0eec0-949d-4629-99b6-e5ba094fb480",
"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-07-07T01:25:21.5759312+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-07T01:25:21.5759312+00:00"
},
"job_status_id": "1114b091-4c59-4555-a3ea-9a06e687bc78",
"job_status_code": "sample string 11",
"db_address_id": "57b63411-d003-4113-a6f6-dc54722bf133",
"contact_id": "ddc85a8d-da97-44cf-90c0-910e4f83ef79",
"requested_by_company_id": "f7689e8a-f44a-4eb3-bb75-a1a80dd25234",
"requested_by_contact_id": "d17b415a-d4b4-4789-9172-2c8640b6d4b3",
"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-07-07T01:25:21.5759312+00:00",
"due_date": "2026-07-07T01:25:21.5759312+00:00",
"date_create": "2026-07-07T01:25:21.5759312+00:00",
"date_update": "2026-07-07T01:25:21.5759312+00:00",
"date_closed": "2026-07-07T01:25:21.5759312+00:00",
"suggested_user_id": "35ca4fe8-72f3-41e7-b253-3cb982679c8d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "46926bfe-b7ac-4970-9126-38b2c999b2a7",
"db_language_id": "a1aa567b-2463-46f4-b936-ec6b70f06416",
"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-07-07T01:25:21.5759312+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1b77762b-06ef-43a3-8a2b-a19c72c64661",
"sales_organization": {
"id": "7e414b15-8083-4de5-aab2-747af6029ecf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e69bdae3-e0e1-4ac5-9442-6ac9601bac4b",
"db_currency_id": "9dfecbc3-c868-41cc-bf89-2506fa9c5549",
"db_language_id": "08b0eec0-949d-4629-99b6-e5ba094fb480",
"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-07-07T01:25:21.5759312+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c241bca3-c8b4-4558-b97d-f3f9ed675d54",
"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": "9cece3b7-e7ff-4bc3-87f2-a139a05ab9ae",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-07T01:25:21.5759312+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0b4faf1b-1615-46c3-a612-368b4969d7a4"
},
"suggested_date_start": "2026-07-07T01:25:21.5759312+00:00",
"skill_id": "5d48b7c3-4d76-4d52-b810-364326c1868c",
"skill_code": "sample string 32",
"skill": {
"id": "e5e2fba2-9fa1-45f3-825e-e42344356c4a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "018bae68-1f5c-4685-a33d-05971789f4cc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7e414b15-8083-4de5-aab2-747af6029ecf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e69bdae3-e0e1-4ac5-9442-6ac9601bac4b",
"db_currency_id": "9dfecbc3-c868-41cc-bf89-2506fa9c5549",
"db_language_id": "08b0eec0-949d-4629-99b6-e5ba094fb480",
"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-07-07T01:25:21.5759312+00:00"
},
"modified_dateutc": "2026-07-07T01:25:21.5759312+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "47b71479-543b-4f8c-bc18-04402f116114",
"date_reported_by_company": "2026-07-07T01:25:21.5759312+00:00",
"id2": 36,
"company_id": "39e075ec-ac5e-4dde-88fd-84c62f9ee071",
"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": "dcb45afb-59a6-41c1-84e6-2adb1cc36c3c",
"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-07-07T01:25:21.5759312+00:00"
},
"work_instruction_details_id": "704bd135-bceb-4d9b-abfe-e8a44f819af7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4341ac76-66f1-42af-8952-b6354aba6c44",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3ae80277-fb33-470f-b152-037d19a78bfc",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-07T01:25:21.5759312+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": "d9fa4173-c77a-4d92-b634-e0c9e9e33b46",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-07T01:25:21.5759312+00:00"
}