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": "d02e9d05-9b75-4381-8c80-eff65ff2b5ee",
"jobs_id": "5cec199a-cce5-4cf1-86b7-10aa7e9a05c6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "24e6947d-03a4-48d6-9e4e-821e0f1273f3",
"_parent_id": "aab32857-fc06-4576-b182-08e9bdd34718",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0e335509-8b8a-424f-9f06-06d37f8c26f4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6052007a-b3a1-49ea-9959-6ca5ec474a34",
"_parent_id": "031e968a-1a88-48c8-aa41-8984b4e57017",
"root_parent_id": "0945c991-c237-44e4-b9c6-11e5e2eb1650",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "789adf16-630f-49d1-8a25-0e3a33879d77",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fec9ec30-08b6-4b92-a8ee-89a98bcfcdcf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3cb212a2-7231-459f-bc42-44923df05542",
"_parent_code": "sample string 6",
"sales_organization_id": "69b8f412-d807-4143-b3e7-792e3ed8478a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1148aca9-2541-461e-9c06-c0e58f2709c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4857e8b1-4c9b-46c4-bfb0-4e12c2aa4d5e",
"db_currency_id": "7820da6c-6ab2-4f89-86f8-d9894515aed4",
"db_language_id": "f60c59d9-5acb-4ed5-b986-4b9d3a6d83c2",
"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-23T11:53:01.1427121+00:00"
},
"modified_dateutc": "2026-07-23T11:53:01.1427121+00:00"
},
"equipment_model_id": "2205afef-a657-4627-8dcf-ddb13c9139fe",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c1a0893b-7fa6-4ad7-8ddf-306ae32811e5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7f8c45d7-fd15-4c52-8e19-e356e56d164b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4e05a2b0-8591-47c0-9038-6df05d01bf9e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6b961440-ae36-4e46-9205-da8502d2cdcb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1148aca9-2541-461e-9c06-c0e58f2709c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4857e8b1-4c9b-46c4-bfb0-4e12c2aa4d5e",
"db_currency_id": "7820da6c-6ab2-4f89-86f8-d9894515aed4",
"db_language_id": "f60c59d9-5acb-4ed5-b986-4b9d3a6d83c2",
"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-23T11:53:01.1427121+00:00"
},
"modified_dateutc": "2026-07-23T11:53:01.1427121+00:00"
},
"equipment_family_id": "fe2d245f-c540-4aaa-83bd-5b3abd2525ad",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fec9ec30-08b6-4b92-a8ee-89a98bcfcdcf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3cb212a2-7231-459f-bc42-44923df05542",
"_parent_code": "sample string 6",
"sales_organization_id": "69b8f412-d807-4143-b3e7-792e3ed8478a",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1148aca9-2541-461e-9c06-c0e58f2709c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4857e8b1-4c9b-46c4-bfb0-4e12c2aa4d5e",
"db_currency_id": "7820da6c-6ab2-4f89-86f8-d9894515aed4",
"db_language_id": "f60c59d9-5acb-4ed5-b986-4b9d3a6d83c2",
"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-23T11:53:01.1427121+00:00"
},
"modified_dateutc": "2026-07-23T11:53:01.1427121+00:00"
},
"date_in_production_since": "2026-07-23T11:53:01.1427121+00:00",
"date_out_of_production_since": "2026-07-23T11:53:01.1427121+00:00",
"date_end_support": "2026-07-23T11:53:01.1427121+00:00",
"sales_organization_id": "0925deb9-84ce-4c8a-b623-af362ee77d67",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1148aca9-2541-461e-9c06-c0e58f2709c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4857e8b1-4c9b-46c4-bfb0-4e12c2aa4d5e",
"db_currency_id": "7820da6c-6ab2-4f89-86f8-d9894515aed4",
"db_language_id": "f60c59d9-5acb-4ed5-b986-4b9d3a6d83c2",
"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-23T11:53:01.1427121+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-23T11:53:01.1427121+00:00"
},
"project_status_id": "c70b0d33-2804-4647-8971-2870f310ad9b",
"project_status_code": "sample string 10",
"project_status": {
"id": "2526a5b3-b64f-4a37-93cc-96909553c09b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9694c9ac-0219-440a-89ad-639d84f64a87",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1148aca9-2541-461e-9c06-c0e58f2709c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4857e8b1-4c9b-46c4-bfb0-4e12c2aa4d5e",
"db_currency_id": "7820da6c-6ab2-4f89-86f8-d9894515aed4",
"db_language_id": "f60c59d9-5acb-4ed5-b986-4b9d3a6d83c2",
"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-23T11:53:01.1427121+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-23T11:53:01.1427121+00:00"
},
"company_id": "decea440-f973-4923-b38a-398724670145",
"company_code": "sample string 12",
"db_address_id": "28c80fc0-a0e4-41c8-af5b-84aefe21fb31",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5f317d98-a062-4c7f-b596-be5e7656a9d2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "135453ed-10d3-495d-9fac-b322feeff906",
"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-23T11:53:01.1427121+00:00",
"date_create": "2026-07-23T11:53:01.1427121+00:00",
"date_update": "2026-07-23T11:53:01.1427121+00:00",
"updated_by_user_id": "00108494-6b76-495a-b54f-985920557e84",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-23T11:53:01.1427121+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-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-23T11:53:01.1427121+00:00",
"date_last_job": "2026-07-23T11:53:01.1427121+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-23T11:53:01.1427121+00:00",
"modified_dateutc": "2026-07-23T11:53:01.1427121+00:00",
"is_mobile_installation": true
},
"job_type_id": "eebcc3f1-1f16-4a37-a80f-efb9395fe245",
"job_type_code": "sample string 7",
"job_type": {
"id": "2ea44ebe-53b6-4cd1-870a-f8004cdf2425",
"name": "sample string 2",
"sales_organization_id": "f6042f0f-2aed-497b-84cf-16ffd4817d28",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-23T11:53:01.1427121+00:00",
"code": "sample string 7"
},
"job_priority_id": "67d1d1c1-83a0-4f47-8bce-5a4ba77fee00",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "aeaf8413-8c65-4c62-a568-44e3e9d325df",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0b4f35f8-83ff-438a-84bd-e1506b9e928f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1148aca9-2541-461e-9c06-c0e58f2709c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4857e8b1-4c9b-46c4-bfb0-4e12c2aa4d5e",
"db_currency_id": "7820da6c-6ab2-4f89-86f8-d9894515aed4",
"db_language_id": "f60c59d9-5acb-4ed5-b986-4b9d3a6d83c2",
"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-23T11:53:01.1427121+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-23T11:53:01.1427121+00:00"
},
"job_status_id": "ec0d5da5-8c53-4628-894f-84b11b0d2bcd",
"job_status_code": "sample string 11",
"db_address_id": "effa7d5f-9692-437a-9723-51ae474e7d43",
"contact_id": "20c5c1b8-b09e-4119-9680-e6ebd7602380",
"requested_by_company_id": "ce078783-c9fe-4fc6-9bdc-5fb4178e20fa",
"requested_by_contact_id": "b23ac2bf-2738-4240-98fe-68d71060b50d",
"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-23T11:53:01.1427121+00:00",
"due_date": "2026-07-23T11:53:01.1427121+00:00",
"date_create": "2026-07-23T11:53:01.1427121+00:00",
"date_update": "2026-07-23T11:53:01.1427121+00:00",
"date_closed": "2026-07-23T11:53:01.1427121+00:00",
"suggested_user_id": "2bda684c-7138-49f4-899d-267101ae14ca",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "94b63541-15f2-4cb3-be23-8da92d6efcdc",
"db_language_id": "6b19f65e-9bf6-49f0-b697-fe7128606412",
"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-23T11:53:01.1427121+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ef33bdf3-1392-4051-83cc-74152823e0b8",
"sales_organization": {
"id": "1148aca9-2541-461e-9c06-c0e58f2709c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4857e8b1-4c9b-46c4-bfb0-4e12c2aa4d5e",
"db_currency_id": "7820da6c-6ab2-4f89-86f8-d9894515aed4",
"db_language_id": "f60c59d9-5acb-4ed5-b986-4b9d3a6d83c2",
"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-23T11:53:01.1427121+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6310fb02-896c-49ad-8a0f-433b26405861",
"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": "94ecb9aa-92b5-4abf-8b3a-e134e50fb544",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-23T11:53:01.1427121+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "43c02414-6bcb-4d5e-b554-5436987e9af0"
},
"suggested_date_start": "2026-07-23T11:53:01.1427121+00:00",
"skill_id": "c7e4b3dd-863a-45d8-902e-a0fb8b76adb7",
"skill_code": "sample string 32",
"skill": {
"id": "49fdb0b3-040c-4ec2-a41b-9f8836302988",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3237e2dd-f946-4151-b70f-d6ca8e435b9a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1148aca9-2541-461e-9c06-c0e58f2709c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4857e8b1-4c9b-46c4-bfb0-4e12c2aa4d5e",
"db_currency_id": "7820da6c-6ab2-4f89-86f8-d9894515aed4",
"db_language_id": "f60c59d9-5acb-4ed5-b986-4b9d3a6d83c2",
"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-23T11:53:01.1427121+00:00"
},
"modified_dateutc": "2026-07-23T11:53:01.1427121+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8bcf4786-634e-410b-8615-0b67a0a7cc07",
"date_reported_by_company": "2026-07-23T11:53:01.1427121+00:00",
"id2": 36,
"company_id": "576945b1-1288-4d7b-ae80-715c7f1ef2aa",
"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": "c6fc2e66-f53b-4ff2-9eb3-02fefe0469da",
"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-23T11:53:01.1427121+00:00"
},
"work_instruction_details_id": "069023e7-591b-4a2e-b452-284ca5dc9a62",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2d34fd1a-9c01-422d-b0ec-cfb9b70133dc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3547224c-7c98-4362-94fb-b67ce614c98f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-23T11:53:01.1427121+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": "007fd182-22a7-41a1-9e19-82aa4b7ac7a6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-23T11:53:01.1427121+00:00"
}