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": "8d415682-c887-4356-9c26-dbe7ef5d65e4",
"jobs_id": "06fbebe0-0983-4ddc-b7ad-710567b31f5c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "31e025d2-bb67-4a4e-84c0-d1ab9be6fc2b",
"_parent_id": "893bc1d1-519a-41b9-b9ed-90ed793f9a36",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "48249bf2-f451-4aec-8a9a-6c8506c28152",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ec7fccee-8afe-4b1b-89fb-daa18f2066c8",
"_parent_id": "2dfe79ee-822b-4bf2-9132-b3ab85643f98",
"root_parent_id": "56ed3e8a-e006-43d6-bb8e-c524992be7b7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d4465da4-3f42-4b7d-bd21-9e09ce367e1f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "21cebf43-f429-4693-9905-f7c4f4a8b151",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "73e0166b-cc6b-4af2-952d-d6aa798a2034",
"_parent_code": "sample string 6",
"sales_organization_id": "6541eca2-a7d0-4cba-a67b-1ef12daeb987",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7ec75a48-2e21-41fd-b39b-1cd82cd03e4a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de3b5c76-d82f-4fb0-beeb-6972ca440a43",
"db_currency_id": "b9ce2770-ff07-4f8a-977f-6325ab91b3c6",
"db_language_id": "1290c6e6-21c7-4c06-9409-31dd51b5f427",
"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-06T23:51:41.020392+00:00"
},
"modified_dateutc": "2026-07-06T23:51:41.020392+00:00"
},
"equipment_model_id": "683dc369-ef1a-4bd2-96fc-21360aecfe4d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4970f7b7-72f0-479f-a439-43c1a74763c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f2f704c6-28c5-432d-aa9b-3ed9878389c5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ee5ac07c-7a45-4194-bce6-333699b57afa",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c9c9e620-49e2-42c2-bce9-38df409c0f5c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7ec75a48-2e21-41fd-b39b-1cd82cd03e4a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de3b5c76-d82f-4fb0-beeb-6972ca440a43",
"db_currency_id": "b9ce2770-ff07-4f8a-977f-6325ab91b3c6",
"db_language_id": "1290c6e6-21c7-4c06-9409-31dd51b5f427",
"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-06T23:51:41.020392+00:00"
},
"modified_dateutc": "2026-07-06T23:51:41.020392+00:00"
},
"equipment_family_id": "05d4ae21-798b-4d1e-91e9-82c209b2b284",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "21cebf43-f429-4693-9905-f7c4f4a8b151",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "73e0166b-cc6b-4af2-952d-d6aa798a2034",
"_parent_code": "sample string 6",
"sales_organization_id": "6541eca2-a7d0-4cba-a67b-1ef12daeb987",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7ec75a48-2e21-41fd-b39b-1cd82cd03e4a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de3b5c76-d82f-4fb0-beeb-6972ca440a43",
"db_currency_id": "b9ce2770-ff07-4f8a-977f-6325ab91b3c6",
"db_language_id": "1290c6e6-21c7-4c06-9409-31dd51b5f427",
"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-06T23:51:41.020392+00:00"
},
"modified_dateutc": "2026-07-06T23:51:41.020392+00:00"
},
"date_in_production_since": "2026-07-06T23:51:41.020392+00:00",
"date_out_of_production_since": "2026-07-06T23:51:41.020392+00:00",
"date_end_support": "2026-07-06T23:51:41.020392+00:00",
"sales_organization_id": "838320ae-89d5-43f1-8448-8bef28033afc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7ec75a48-2e21-41fd-b39b-1cd82cd03e4a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de3b5c76-d82f-4fb0-beeb-6972ca440a43",
"db_currency_id": "b9ce2770-ff07-4f8a-977f-6325ab91b3c6",
"db_language_id": "1290c6e6-21c7-4c06-9409-31dd51b5f427",
"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-06T23:51:41.020392+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-06T23:51:41.020392+00:00"
},
"project_status_id": "20eedc0a-5c1d-4754-a1f5-9a70c760436d",
"project_status_code": "sample string 10",
"project_status": {
"id": "4d87c20f-cdb8-4b1d-994d-8e3ff264a284",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c58f8e2d-df60-4487-ae22-5c58c4c56373",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7ec75a48-2e21-41fd-b39b-1cd82cd03e4a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de3b5c76-d82f-4fb0-beeb-6972ca440a43",
"db_currency_id": "b9ce2770-ff07-4f8a-977f-6325ab91b3c6",
"db_language_id": "1290c6e6-21c7-4c06-9409-31dd51b5f427",
"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-06T23:51:41.020392+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-06T23:51:41.020392+00:00"
},
"company_id": "5f374063-97a7-44e7-975b-a4120f2d50e6",
"company_code": "sample string 12",
"db_address_id": "a7ef0684-c895-495d-8eab-277650eea440",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "36e44709-6438-4e9d-91c0-d508e356eef7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "90f757f0-9934-477b-80dc-fd8274be118c",
"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-06T23:51:41.020392+00:00",
"date_create": "2026-07-06T23:51:41.020392+00:00",
"date_update": "2026-07-06T23:51:41.020392+00:00",
"updated_by_user_id": "84d76e9e-e92a-4860-bf47-7f9247a64894",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-06T23:51:41.020392+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-06T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-06T23:51:41.020392+00:00",
"date_last_job": "2026-07-06T23:51:41.020392+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-06T23:51:41.020392+00:00",
"modified_dateutc": "2026-07-06T23:51:41.020392+00:00",
"is_mobile_installation": true
},
"job_type_id": "417e0017-6453-4862-a020-7b3669ec776c",
"job_type_code": "sample string 7",
"job_type": {
"id": "0d5c7d10-44a3-49de-8989-087310f51f61",
"name": "sample string 2",
"sales_organization_id": "4293c04d-9f8b-4b72-83c5-57ebc6021410",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-06T23:51:41.020392+00:00",
"code": "sample string 7"
},
"job_priority_id": "b1f44b0c-7f54-4258-ae48-dae1c689822f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1f19c4e7-c8c1-481c-8d6d-da3475223a4b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9ced0a45-280d-4d81-90c1-dc8dc78ea812",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7ec75a48-2e21-41fd-b39b-1cd82cd03e4a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de3b5c76-d82f-4fb0-beeb-6972ca440a43",
"db_currency_id": "b9ce2770-ff07-4f8a-977f-6325ab91b3c6",
"db_language_id": "1290c6e6-21c7-4c06-9409-31dd51b5f427",
"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-06T23:51:41.020392+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-06T23:51:41.020392+00:00"
},
"job_status_id": "c6c3f475-c7ef-4e6b-9638-7662a2850fc2",
"job_status_code": "sample string 11",
"db_address_id": "3540e886-fbe3-4a31-ac1e-05067bc1e3b9",
"contact_id": "f750b450-40d3-4479-b92e-263c06a7b459",
"requested_by_company_id": "04b3dbc0-4519-47bc-84ab-b93f15148f7c",
"requested_by_contact_id": "f1279c70-0412-4ba3-aea9-a2396e0a7b6e",
"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-06T23:51:41.020392+00:00",
"due_date": "2026-07-06T23:51:41.020392+00:00",
"date_create": "2026-07-06T23:51:41.020392+00:00",
"date_update": "2026-07-06T23:51:41.020392+00:00",
"date_closed": "2026-07-06T23:51:41.020392+00:00",
"suggested_user_id": "5f14cd09-683b-4369-97f8-ebd1e9b5e7ca",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b1bbda5e-938d-4d69-9959-8dd29943afb3",
"db_language_id": "6f9171f1-6bfd-479d-b4cf-a5c3bdf9a51d",
"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-06T23:51:41.020392+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2dce2f68-786f-4721-83b4-3cc7a9d9026a",
"sales_organization": {
"id": "7ec75a48-2e21-41fd-b39b-1cd82cd03e4a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de3b5c76-d82f-4fb0-beeb-6972ca440a43",
"db_currency_id": "b9ce2770-ff07-4f8a-977f-6325ab91b3c6",
"db_language_id": "1290c6e6-21c7-4c06-9409-31dd51b5f427",
"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-06T23:51:41.020392+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2e8110c2-4c5f-48de-85ef-eee0673910be",
"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": "89951e3e-6850-4338-bcea-86af56c6a685",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-06T23:51:41.020392+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0ce6d22a-b9d4-4b34-9382-11065bf31860"
},
"suggested_date_start": "2026-07-06T23:51:41.020392+00:00",
"skill_id": "f26351f0-06f8-4dd9-8411-9f9b2aeab497",
"skill_code": "sample string 32",
"skill": {
"id": "f7310233-075c-4bf3-88be-41c785bc36fe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c1e58a98-930a-4fe5-b0da-3f8001c8f671",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7ec75a48-2e21-41fd-b39b-1cd82cd03e4a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "de3b5c76-d82f-4fb0-beeb-6972ca440a43",
"db_currency_id": "b9ce2770-ff07-4f8a-977f-6325ab91b3c6",
"db_language_id": "1290c6e6-21c7-4c06-9409-31dd51b5f427",
"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-06T23:51:41.020392+00:00"
},
"modified_dateutc": "2026-07-06T23:51:41.020392+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ae242aaf-637d-4a66-91f7-01c2991faffc",
"date_reported_by_company": "2026-07-06T23:51:41.020392+00:00",
"id2": 36,
"company_id": "ecc73b77-c12b-4135-b14d-09ed6dc1cf51",
"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": "dc982437-65d2-4bb9-b2e2-dc44f60514ca",
"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-06T23:51:41.020392+00:00"
},
"work_instruction_details_id": "c80c6243-ddcb-4c13-95b7-fd21cbe6e512",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e66038a6-02b1-42ea-8e71-073116657948",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2160bbe9-35ef-4fcf-8ecd-1fedd3bbec2b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-06T23:51:41.020392+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": "a3eb1215-ad85-409d-9822-bcef5059f308",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-06T23:51:41.020392+00:00"
}