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": "33f48f05-f02b-4ba5-bb4f-940140dbed3f",
"jobs_id": "c9510cf0-c705-4366-94d6-79f0a5ac9758",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "28dc34ad-5fb2-47c0-9b85-347d787b322c",
"_parent_id": "011f891e-34ea-44d9-95da-f31744c78be7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c15e1e35-9971-4cc8-9cae-32af5764ea6b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9c31f04c-d7e7-4f72-99ee-325e879d19e4",
"_parent_id": "4c564ad5-085a-4bad-9c88-0ee7d8fc8e8f",
"root_parent_id": "901918a3-4cfa-40a9-baa6-f08f6795f3cd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6f07848a-9395-45e2-9d58-a9136887970f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "bd110e55-6f07-4dd1-810b-a5c74f694f04",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ac7ed0a2-6f1b-448e-ae5f-89f81dadf12f",
"_parent_code": "sample string 6",
"sales_organization_id": "46a28819-37c9-43cf-ae89-5bca870cb806",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0158f695-c444-4621-b60a-27748d4ec244",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "675bfa18-3720-4db3-b9c1-13a485afe01e",
"db_currency_id": "6747ad9a-9b2d-45ef-af75-03914512192b",
"db_language_id": "cfb52390-35e2-42d0-bd91-4ce58a3ba132",
"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-04T03:29:23.6372526+00:00"
},
"modified_dateutc": "2025-11-04T03:29:23.6372526+00:00"
},
"equipment_model_id": "4861c68e-5646-43fa-b54f-66ccdfa65b50",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d2daca48-a2e7-4eb5-b82f-8b39a854d8f9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "981dde14-0a13-4761-8a31-127bc1a006ac",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "21e258b5-2bbd-408d-9383-b640409584a3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a6e06a00-1102-4b07-868e-8da59c453527",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0158f695-c444-4621-b60a-27748d4ec244",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "675bfa18-3720-4db3-b9c1-13a485afe01e",
"db_currency_id": "6747ad9a-9b2d-45ef-af75-03914512192b",
"db_language_id": "cfb52390-35e2-42d0-bd91-4ce58a3ba132",
"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-04T03:29:23.6372526+00:00"
},
"modified_dateutc": "2025-11-04T03:29:23.6372526+00:00"
},
"equipment_family_id": "5d9a32c0-e008-4073-b369-624e9438e1ad",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "bd110e55-6f07-4dd1-810b-a5c74f694f04",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ac7ed0a2-6f1b-448e-ae5f-89f81dadf12f",
"_parent_code": "sample string 6",
"sales_organization_id": "46a28819-37c9-43cf-ae89-5bca870cb806",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0158f695-c444-4621-b60a-27748d4ec244",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "675bfa18-3720-4db3-b9c1-13a485afe01e",
"db_currency_id": "6747ad9a-9b2d-45ef-af75-03914512192b",
"db_language_id": "cfb52390-35e2-42d0-bd91-4ce58a3ba132",
"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-04T03:29:23.6372526+00:00"
},
"modified_dateutc": "2025-11-04T03:29:23.6372526+00:00"
},
"date_in_production_since": "2025-11-04T03:29:23.6372526+00:00",
"date_out_of_production_since": "2025-11-04T03:29:23.6372526+00:00",
"date_end_support": "2025-11-04T03:29:23.6372526+00:00",
"sales_organization_id": "fc95d986-0fe7-4801-8aa3-763ed62b192d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0158f695-c444-4621-b60a-27748d4ec244",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "675bfa18-3720-4db3-b9c1-13a485afe01e",
"db_currency_id": "6747ad9a-9b2d-45ef-af75-03914512192b",
"db_language_id": "cfb52390-35e2-42d0-bd91-4ce58a3ba132",
"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-04T03:29:23.6372526+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-04T03:29:23.6372526+00:00"
},
"project_status_id": "ae04d9a9-b504-4ef1-b1f8-cbe967e45283",
"project_status_code": "sample string 10",
"project_status": {
"id": "4d9f5aa7-6c14-4255-9012-cfd23451a6ea",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f09188b7-3a93-433e-b504-3d8ee1619b49",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0158f695-c444-4621-b60a-27748d4ec244",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "675bfa18-3720-4db3-b9c1-13a485afe01e",
"db_currency_id": "6747ad9a-9b2d-45ef-af75-03914512192b",
"db_language_id": "cfb52390-35e2-42d0-bd91-4ce58a3ba132",
"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-04T03:29:23.6372526+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-04T03:29:23.6372526+00:00"
},
"company_id": "c75a8a5a-1f4b-4025-b2db-8de6eb9c6a9c",
"company_code": "sample string 12",
"db_address_id": "118628b9-b164-4bbf-9229-bc1fece005bd",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "84da48f6-b4bc-4ed1-842d-195a35eb1a2d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "09f7195f-d14d-43c4-8e8a-351c79b2c1dd",
"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-04T03:29:23.6372526+00:00",
"date_create": "2025-11-04T03:29:23.6372526+00:00",
"date_update": "2025-11-04T03:29:23.6372526+00:00",
"updated_by_user_id": "9ed91170-b617-459b-a71e-3aec760b969d",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-04T03:29:23.6372526+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-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-04T03:29:23.6372526+00:00",
"date_last_job": "2025-11-04T03:29:23.6372526+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-04T03:29:23.6372526+00:00",
"modified_dateutc": "2025-11-04T03:29:23.6372526+00:00",
"is_mobile_installation": true
},
"job_type_id": "12661d5a-5f98-4203-8c1a-68138a1e475c",
"job_type_code": "sample string 7",
"job_type": {
"id": "1246b34a-b102-4b76-a897-7510329be39a",
"name": "sample string 2",
"sales_organization_id": "ec123c03-0d31-45c7-8ca7-e6dc05be1ee8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-04T03:29:23.6372526+00:00",
"code": "sample string 7"
},
"job_priority_id": "7daf6013-bb5f-46d2-a054-3e5fb75e9a37",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "16449efd-0db8-43df-9c41-9cf92c00650c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ec7577d9-dc8c-4eed-8d09-1c4cd54478a2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0158f695-c444-4621-b60a-27748d4ec244",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "675bfa18-3720-4db3-b9c1-13a485afe01e",
"db_currency_id": "6747ad9a-9b2d-45ef-af75-03914512192b",
"db_language_id": "cfb52390-35e2-42d0-bd91-4ce58a3ba132",
"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-04T03:29:23.6372526+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-04T03:29:23.6372526+00:00"
},
"job_status_id": "c2c6a8c4-f973-41ad-a077-df7ec23e221a",
"job_status_code": "sample string 11",
"db_address_id": "58b325a9-ee52-48cc-844b-dfc41ef446aa",
"contact_id": "fade5819-5449-4043-a9cf-d1d17ddad628",
"requested_by_company_id": "0f10c28b-0e87-45cb-aa7a-8d54c047e09d",
"requested_by_contact_id": "1e937140-d4c7-4f4e-bb82-0be430b4ed60",
"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-04T03:29:23.6372526+00:00",
"due_date": "2025-11-04T03:29:23.6372526+00:00",
"date_create": "2025-11-04T03:29:23.6372526+00:00",
"date_update": "2025-11-04T03:29:23.6372526+00:00",
"date_closed": "2025-11-04T03:29:23.6372526+00:00",
"suggested_user_id": "28a96fc7-9fee-4e87-af9f-0b7f4e6da61f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "dc11b32d-15ca-4dcc-bb2c-3a1c14dfc9c0",
"db_language_id": "0f0dbd36-6b06-41d9-b35d-8f7e63f20f86",
"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-04T03:29:23.6372526+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "79b596e8-1b13-4678-b1b1-a3ebf9ee804f",
"sales_organization": {
"id": "0158f695-c444-4621-b60a-27748d4ec244",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "675bfa18-3720-4db3-b9c1-13a485afe01e",
"db_currency_id": "6747ad9a-9b2d-45ef-af75-03914512192b",
"db_language_id": "cfb52390-35e2-42d0-bd91-4ce58a3ba132",
"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-04T03:29:23.6372526+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d32f2ce4-d150-4bc4-b265-1e5ef9284da4",
"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": "d7d82340-e7be-4470-baec-badcb34a68d4",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-04T03:29:23.6372526+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1f3a829c-31c8-4b9d-965e-c57a42d477a4"
},
"suggested_date_start": "2025-11-04T03:29:23.6372526+00:00",
"skill_id": "0bdbd728-7ca5-409f-8c90-f5bd8298ee66",
"skill_code": "sample string 32",
"skill": {
"id": "6092df4a-99e5-4a6d-b193-9bcc3efa08ba",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e231d397-1229-45ff-b5d6-561a85d81439",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0158f695-c444-4621-b60a-27748d4ec244",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "675bfa18-3720-4db3-b9c1-13a485afe01e",
"db_currency_id": "6747ad9a-9b2d-45ef-af75-03914512192b",
"db_language_id": "cfb52390-35e2-42d0-bd91-4ce58a3ba132",
"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-04T03:29:23.6372526+00:00"
},
"modified_dateutc": "2025-11-04T03:29:23.6372526+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "19c01c8c-2817-4bd5-9f2a-5ef78421b604",
"date_reported_by_company": "2025-11-04T03:29:23.6372526+00:00",
"id2": 36,
"company_id": "d6b5fc9e-c27a-4989-8891-e44d9ccc510d",
"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": "ac309f87-04ca-450b-9b10-8e4ad462ad34",
"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-04T03:29:23.6372526+00:00"
},
"work_instruction_details_id": "aa4f51fc-918e-448c-8d10-0c62c574f8ba",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "be4696d5-3afb-41cd-9a3b-94e98fc89dfc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5f371664-8302-4479-9ec1-1886df7c0b78",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-04T03:29:23.6372526+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": "a3c1ed7f-0dc5-4055-9d2e-4b73577cb4e5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-04T03:29:23.6372526+00:00"
}