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": "a6ccf434-9071-40e3-9f45-f76e5cd3958a",
"jobs_id": "31586301-06b7-45f2-9dff-acc0d57daa6d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c53a780d-9744-4fd9-84a4-c82614860aba",
"_parent_id": "b091c9bf-5c23-4ae6-8f8f-70f6d88ae749",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "674891a2-e34d-4a06-8cfa-3a4509999439",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c6d3131a-9a79-4904-b957-5b18b98398ec",
"_parent_id": "95f7b890-0478-4fe9-a8e4-1d00b6e9f7c3",
"root_parent_id": "3e4b8a67-dddb-4470-ac62-807b8ebb9d77",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2bd744d2-830e-46f7-bc6c-7e84273b745f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "d6dc485a-dbdd-4b87-bf98-5159cea4ffdc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b3ef2727-e5a8-4cf9-b66b-40832445dd6e",
"_parent_code": "sample string 6",
"sales_organization_id": "446ba93e-ae93-4aa0-b15d-e8f0344e638d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "41851327-85d2-40a8-ac2f-b5eeda44732d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d495cb4-a898-4f2f-8e33-98578405a64e",
"db_currency_id": "82c579a2-7e5a-402f-9acc-e030b7be2dfd",
"db_language_id": "98c74b34-c72f-4e78-920e-5fc5b0966e3f",
"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-12-29T17:51:38.6959316+00:00"
},
"modified_dateutc": "2025-12-29T17:51:38.6959316+00:00"
},
"equipment_model_id": "93f3429c-36bf-41c6-b653-383adfcbd5ea",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "79d19d73-8b75-4ad2-aa70-d7411f8776d9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5fc7680d-4217-4d4f-ab0e-894e128a69eb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "306b6564-bbb1-499a-bb5c-ad5d04b24c28",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3e4a22f7-06f8-4392-baab-1f7164430f79",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "41851327-85d2-40a8-ac2f-b5eeda44732d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d495cb4-a898-4f2f-8e33-98578405a64e",
"db_currency_id": "82c579a2-7e5a-402f-9acc-e030b7be2dfd",
"db_language_id": "98c74b34-c72f-4e78-920e-5fc5b0966e3f",
"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-12-29T17:51:38.6959316+00:00"
},
"modified_dateutc": "2025-12-29T17:51:38.6959316+00:00"
},
"equipment_family_id": "cec72e58-15d2-475c-9ccb-e05ac37df850",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "d6dc485a-dbdd-4b87-bf98-5159cea4ffdc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b3ef2727-e5a8-4cf9-b66b-40832445dd6e",
"_parent_code": "sample string 6",
"sales_organization_id": "446ba93e-ae93-4aa0-b15d-e8f0344e638d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "41851327-85d2-40a8-ac2f-b5eeda44732d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d495cb4-a898-4f2f-8e33-98578405a64e",
"db_currency_id": "82c579a2-7e5a-402f-9acc-e030b7be2dfd",
"db_language_id": "98c74b34-c72f-4e78-920e-5fc5b0966e3f",
"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-12-29T17:51:38.6959316+00:00"
},
"modified_dateutc": "2025-12-29T17:51:38.6959316+00:00"
},
"date_in_production_since": "2025-12-29T17:51:38.6959316+00:00",
"date_out_of_production_since": "2025-12-29T17:51:38.6959316+00:00",
"date_end_support": "2025-12-29T17:51:38.6959316+00:00",
"sales_organization_id": "f905d836-7f5f-4218-a1fe-590134034e94",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "41851327-85d2-40a8-ac2f-b5eeda44732d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d495cb4-a898-4f2f-8e33-98578405a64e",
"db_currency_id": "82c579a2-7e5a-402f-9acc-e030b7be2dfd",
"db_language_id": "98c74b34-c72f-4e78-920e-5fc5b0966e3f",
"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-12-29T17:51:38.6959316+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-12-29T17:51:38.6959316+00:00"
},
"project_status_id": "bb984fb2-216c-4206-82dc-87c6b600d4f5",
"project_status_code": "sample string 10",
"project_status": {
"id": "1761316d-c38a-4c8f-8e78-7b09df7257d8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "79c0b8fb-69ba-4647-86ec-5123334ee4c0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "41851327-85d2-40a8-ac2f-b5eeda44732d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d495cb4-a898-4f2f-8e33-98578405a64e",
"db_currency_id": "82c579a2-7e5a-402f-9acc-e030b7be2dfd",
"db_language_id": "98c74b34-c72f-4e78-920e-5fc5b0966e3f",
"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-12-29T17:51:38.6959316+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-29T17:51:38.6959316+00:00"
},
"company_id": "04c0e9b2-6a72-4546-9650-e980b2addd0e",
"company_code": "sample string 12",
"db_address_id": "135ddda2-fb81-4679-9cde-e964edec71ee",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6b580700-01f6-4752-9e65-be595456a503",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "21b1860a-295e-41c2-942c-80ebd3271135",
"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-12-29T17:51:38.6959316+00:00",
"date_create": "2025-12-29T17:51:38.6959316+00:00",
"date_update": "2025-12-29T17:51:38.6959316+00:00",
"updated_by_user_id": "d5dc83d9-30fd-498f-84c2-458f78366883",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-29T17:51:38.6959316+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-12-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-29T17:51:38.6959316+00:00",
"date_last_job": "2025-12-29T17:51:38.6959316+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-29T17:51:38.6959316+00:00",
"modified_dateutc": "2025-12-29T17:51:38.6959316+00:00",
"is_mobile_installation": true
},
"job_type_id": "813c8c22-e570-4bbf-bcb8-4da208a8b9ff",
"job_type_code": "sample string 7",
"job_type": {
"id": "253f8e4c-35c3-40ee-b681-a257413762bc",
"name": "sample string 2",
"sales_organization_id": "6681fafa-f088-4962-be3e-792070a074ea",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-29T17:51:38.6959316+00:00",
"code": "sample string 7"
},
"job_priority_id": "3ce15f11-054b-421b-aa33-7ee9590cd444",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "341874f5-bbc4-4887-9708-d2ac9afd539c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e3c5cb5d-ad2e-4ccd-9a29-15d6e4c502d5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "41851327-85d2-40a8-ac2f-b5eeda44732d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d495cb4-a898-4f2f-8e33-98578405a64e",
"db_currency_id": "82c579a2-7e5a-402f-9acc-e030b7be2dfd",
"db_language_id": "98c74b34-c72f-4e78-920e-5fc5b0966e3f",
"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-12-29T17:51:38.6959316+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-29T17:51:38.6959316+00:00"
},
"job_status_id": "5fadfd95-2818-4628-bac7-8cd48fac75b7",
"job_status_code": "sample string 11",
"db_address_id": "2ebf3d6b-818f-43d3-948c-29e3160227f3",
"contact_id": "2b110304-4208-4d64-b278-9928891480be",
"requested_by_company_id": "72052a5e-ba47-47bb-822b-e4cd0dd9c3e0",
"requested_by_contact_id": "37a4510d-66da-46bd-b929-e8a9ee1335cc",
"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-12-29T17:51:38.6959316+00:00",
"due_date": "2025-12-29T17:51:38.6959316+00:00",
"date_create": "2025-12-29T17:51:38.6959316+00:00",
"date_update": "2025-12-29T17:51:38.6959316+00:00",
"date_closed": "2025-12-29T17:51:38.6959316+00:00",
"suggested_user_id": "0a68bdc5-29a4-4e00-b4dc-2baee369d828",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1c2762bc-d280-4d1d-b720-0a6c35b96212",
"db_language_id": "1087976d-80e1-4ed7-a487-e6330b5151f8",
"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-12-29T17:51:38.6959316+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b2576652-1f95-408d-af63-4763b3ad9db4",
"sales_organization": {
"id": "41851327-85d2-40a8-ac2f-b5eeda44732d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d495cb4-a898-4f2f-8e33-98578405a64e",
"db_currency_id": "82c579a2-7e5a-402f-9acc-e030b7be2dfd",
"db_language_id": "98c74b34-c72f-4e78-920e-5fc5b0966e3f",
"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-12-29T17:51:38.6959316+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "660fdccf-378c-4de4-99fd-fdcaa78a52ea",
"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": "5104ea72-ec4e-4d0b-aa1a-011a0d3f149b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-29T17:51:38.6959316+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "97718f7c-4684-40e2-b2c4-15661dd9753c"
},
"suggested_date_start": "2025-12-29T17:51:38.6959316+00:00",
"skill_id": "eb7dbbc5-de3c-4f10-b325-5d28dc6c92f6",
"skill_code": "sample string 32",
"skill": {
"id": "b829c06a-b5e6-418e-bce8-a9889f3cf5c4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bef4e76e-cea5-44a0-b930-ad746573718d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "41851327-85d2-40a8-ac2f-b5eeda44732d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2d495cb4-a898-4f2f-8e33-98578405a64e",
"db_currency_id": "82c579a2-7e5a-402f-9acc-e030b7be2dfd",
"db_language_id": "98c74b34-c72f-4e78-920e-5fc5b0966e3f",
"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-12-29T17:51:38.6959316+00:00"
},
"modified_dateutc": "2025-12-29T17:51:38.6959316+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "399a7a93-eb90-4bf5-86fe-03ca5c5c2c12",
"date_reported_by_company": "2025-12-29T17:51:38.6959316+00:00",
"id2": 36,
"company_id": "df4c04a2-fa65-4cd1-9309-8071bcbaec9a",
"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": "626154a8-02db-49a4-8915-c34c1e58911c",
"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-12-29T17:51:38.6959316+00:00"
},
"work_instruction_details_id": "4ec9757c-d321-4549-b941-e4c07a5cce2b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9870b789-f51c-434a-b6f7-0f869edc3fad",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7750fe36-2985-4b89-a34e-a341ab61017b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-29T17:51:38.6959316+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": "a33020cf-f84a-4d34-8d61-b65b908f38cc",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-29T17:51:38.6959316+00:00"
}