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": "c175bf3e-4cfa-43a0-a4d0-50793adab357",
"jobs_id": "81814d87-d5b9-47d7-b710-3bb411c4bafb",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5ba75376-a57a-4a74-96cf-b4c872c5daa4",
"_parent_id": "07116c04-fadf-4d84-aa50-c01968b3e2a4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6944853d-e79f-4c68-8185-f85cac487fa7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "74c8cb72-163b-4e13-b51b-a097d850bd26",
"_parent_id": "99177d9f-93d8-43c1-96c4-4c70e2406505",
"root_parent_id": "1b99b5ce-0a80-4c1b-963c-4d9cb0e17c65",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c14c7407-787f-4516-85f5-29c17a33908b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "720daba3-d7da-4b53-bf00-cb0f33bd2eb3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "184649a1-a1e2-418f-9a62-c117f29f2874",
"_parent_code": "sample string 6",
"sales_organization_id": "78380433-1b8d-4e75-94dc-b58da83ac244",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b4e0ddf8-32ad-497b-88e8-ef1dc3767ec4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66982a26-e87e-4e16-b97a-aa863b36a3a1",
"db_currency_id": "652bb31d-d010-45c4-b26d-ef1ec9858226",
"db_language_id": "ab0c1e09-fdf8-4c6f-b90a-68275ee26f7d",
"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-02T06:31:31.9095659+00:00"
},
"modified_dateutc": "2026-07-02T06:31:31.9095659+00:00"
},
"equipment_model_id": "7e43c9c2-8330-4ae6-9c60-99cd2ca48302",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6438e558-94b5-4584-aa89-5945bb1a9c1a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4f0ea2f2-7c81-466f-a19b-e23e63ab750c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d86739b6-8314-4f91-a17a-8b473f51bfc1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "483c2ab7-5aa4-4565-b89b-7bd96bb931d9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b4e0ddf8-32ad-497b-88e8-ef1dc3767ec4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66982a26-e87e-4e16-b97a-aa863b36a3a1",
"db_currency_id": "652bb31d-d010-45c4-b26d-ef1ec9858226",
"db_language_id": "ab0c1e09-fdf8-4c6f-b90a-68275ee26f7d",
"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-02T06:31:31.9095659+00:00"
},
"modified_dateutc": "2026-07-02T06:31:31.9095659+00:00"
},
"equipment_family_id": "dfe1ab48-6278-4be8-abdb-8130c3308817",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "720daba3-d7da-4b53-bf00-cb0f33bd2eb3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "184649a1-a1e2-418f-9a62-c117f29f2874",
"_parent_code": "sample string 6",
"sales_organization_id": "78380433-1b8d-4e75-94dc-b58da83ac244",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b4e0ddf8-32ad-497b-88e8-ef1dc3767ec4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66982a26-e87e-4e16-b97a-aa863b36a3a1",
"db_currency_id": "652bb31d-d010-45c4-b26d-ef1ec9858226",
"db_language_id": "ab0c1e09-fdf8-4c6f-b90a-68275ee26f7d",
"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-02T06:31:31.9095659+00:00"
},
"modified_dateutc": "2026-07-02T06:31:31.9095659+00:00"
},
"date_in_production_since": "2026-07-02T06:31:31.9095659+00:00",
"date_out_of_production_since": "2026-07-02T06:31:31.9095659+00:00",
"date_end_support": "2026-07-02T06:31:31.9095659+00:00",
"sales_organization_id": "5fef38d6-5ca3-4143-9452-c71f43b133e2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b4e0ddf8-32ad-497b-88e8-ef1dc3767ec4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66982a26-e87e-4e16-b97a-aa863b36a3a1",
"db_currency_id": "652bb31d-d010-45c4-b26d-ef1ec9858226",
"db_language_id": "ab0c1e09-fdf8-4c6f-b90a-68275ee26f7d",
"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-02T06:31:31.9095659+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-02T06:31:31.9095659+00:00"
},
"project_status_id": "75ba395f-b3fc-4363-b988-ac8903ef26f8",
"project_status_code": "sample string 10",
"project_status": {
"id": "9ede68fe-1989-48ab-b2d1-617f01c842f1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "914053de-eb4b-4807-ad88-bd205f8a2934",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b4e0ddf8-32ad-497b-88e8-ef1dc3767ec4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66982a26-e87e-4e16-b97a-aa863b36a3a1",
"db_currency_id": "652bb31d-d010-45c4-b26d-ef1ec9858226",
"db_language_id": "ab0c1e09-fdf8-4c6f-b90a-68275ee26f7d",
"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-02T06:31:31.9095659+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-02T06:31:31.9095659+00:00"
},
"company_id": "3d143dfc-4ad0-47f7-8cb7-1785c69aee5b",
"company_code": "sample string 12",
"db_address_id": "0a211338-54d7-409b-92f2-23f539e7326e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fa9d3c0c-b49a-47a9-b106-b7ab03553bec",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a37b6c66-6df6-43ca-93c2-b76ba776a308",
"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-02T06:31:31.9095659+00:00",
"date_create": "2026-07-02T06:31:31.9095659+00:00",
"date_update": "2026-07-02T06:31:31.9095659+00:00",
"updated_by_user_id": "2a1d85d7-b774-4338-9bb6-45b601056390",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-02T06:31:31.9095659+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-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-02T06:31:31.9095659+00:00",
"date_last_job": "2026-07-02T06:31:31.9095659+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-02T06:31:31.9095659+00:00",
"modified_dateutc": "2026-07-02T06:31:31.9095659+00:00",
"is_mobile_installation": true
},
"job_type_id": "3edfa726-e2ef-4237-96a6-9169360d4b2d",
"job_type_code": "sample string 7",
"job_type": {
"id": "da1b394b-9b14-40c6-98c6-4c877101b55e",
"name": "sample string 2",
"sales_organization_id": "963d03d3-66d0-4f41-9fd2-04f1ab6453c0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-02T06:31:31.9095659+00:00",
"code": "sample string 7"
},
"job_priority_id": "efd84df2-8ba3-4bb0-b2e0-36526c8c142f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "415d39da-e4d8-4115-8ab5-66d51364cce3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b3064bec-32e3-47b4-a05e-d68c68a7f14f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b4e0ddf8-32ad-497b-88e8-ef1dc3767ec4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66982a26-e87e-4e16-b97a-aa863b36a3a1",
"db_currency_id": "652bb31d-d010-45c4-b26d-ef1ec9858226",
"db_language_id": "ab0c1e09-fdf8-4c6f-b90a-68275ee26f7d",
"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-02T06:31:31.9095659+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-02T06:31:31.9095659+00:00"
},
"job_status_id": "4eebed12-d52a-4164-9251-372ef1257a2b",
"job_status_code": "sample string 11",
"db_address_id": "837996ac-74f7-439f-9415-917d618ecd95",
"contact_id": "7869862c-fc8c-41ee-a2fd-89fc79249be7",
"requested_by_company_id": "455d2a98-7d19-4931-8a04-833a3d823437",
"requested_by_contact_id": "e3986f63-0194-4c5a-b285-ea9928b728c3",
"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-02T06:31:31.9095659+00:00",
"due_date": "2026-07-02T06:31:31.9095659+00:00",
"date_create": "2026-07-02T06:31:31.9095659+00:00",
"date_update": "2026-07-02T06:31:31.9095659+00:00",
"date_closed": "2026-07-02T06:31:31.9095659+00:00",
"suggested_user_id": "9183a060-2666-43d3-b705-b7eb670ddc81",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2799f800-633b-4ba5-bbf1-31af7f905193",
"db_language_id": "e77cc8b6-4dd4-415d-8306-9ea2263598c3",
"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-02T06:31:31.9095659+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8650739a-d8e0-4b99-b079-51971db7e8c1",
"sales_organization": {
"id": "b4e0ddf8-32ad-497b-88e8-ef1dc3767ec4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66982a26-e87e-4e16-b97a-aa863b36a3a1",
"db_currency_id": "652bb31d-d010-45c4-b26d-ef1ec9858226",
"db_language_id": "ab0c1e09-fdf8-4c6f-b90a-68275ee26f7d",
"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-02T06:31:31.9095659+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "44e3f93f-6339-424b-960d-7947bd64fe64",
"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": "c2fffe7b-394b-472c-9204-f64fe6171b66",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-02T06:31:31.9095659+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ce870cc9-d651-48c6-97cc-af1ed2122580"
},
"suggested_date_start": "2026-07-02T06:31:31.9095659+00:00",
"skill_id": "a7ef6a4f-de63-46f2-8060-1c8def44d68a",
"skill_code": "sample string 32",
"skill": {
"id": "68f7f7f9-9978-4e94-8eb7-4f887c122146",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7324d7d5-f699-4fd4-bb58-38d4b2795211",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b4e0ddf8-32ad-497b-88e8-ef1dc3767ec4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "66982a26-e87e-4e16-b97a-aa863b36a3a1",
"db_currency_id": "652bb31d-d010-45c4-b26d-ef1ec9858226",
"db_language_id": "ab0c1e09-fdf8-4c6f-b90a-68275ee26f7d",
"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-02T06:31:31.9095659+00:00"
},
"modified_dateutc": "2026-07-02T06:31:31.9095659+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c94de78a-6c6b-41a6-a710-8516c9fecfbc",
"date_reported_by_company": "2026-07-02T06:31:31.9095659+00:00",
"id2": 36,
"company_id": "cff6c1d5-3e28-487c-b486-5007ef594223",
"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": "e2f8a011-4f3c-46f7-818d-2ba0d4499efc",
"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-02T06:31:31.9095659+00:00"
},
"work_instruction_details_id": "d13ded39-53aa-4e9f-ba1e-8e3af6631338",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "131ff23f-f294-4463-b039-7089ac2c2068",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "aa5e3ded-5d04-4e39-9180-11907aac279c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-02T06:31:31.9095659+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": "aee8642c-ed78-4e03-9d95-52ec44f77aa7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-02T06:31:31.9095659+00:00"
}