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": "33340ba9-ccc6-4038-a883-f4abec27a201",
"jobs_id": "a9e7747c-efb4-4fac-95cc-69483ab050a8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0295360a-043c-4307-b3a4-490be08395fe",
"_parent_id": "3e57d9cd-c7e9-4c18-9f59-97656a156691",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "aa34b618-1a1a-4585-bfff-b37ca65617a4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2756a363-d18d-4103-a4e0-84df5cfe9745",
"_parent_id": "719e39c4-0aff-42a9-b1b9-e6e8c67b0387",
"root_parent_id": "85ac19f9-79b8-4418-81e4-8568f2c40463",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a1fc577e-020c-4a26-88d9-35c24541d9fc",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "68e7ad5d-5d64-43c4-9096-8cae63de349e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "78eb5e32-ec7c-4340-bf16-3167fc79ae11",
"_parent_code": "sample string 6",
"sales_organization_id": "0a4536de-7970-4eaf-a922-773d79f80b32",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8a4ab066-150a-45af-8372-bdb40a03000d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13f8b166-4dfb-4048-a550-8a13fe526628",
"db_currency_id": "04894dc2-a65e-4216-ac16-6696d6dbadb5",
"db_language_id": "bbde8d9d-2c69-4c11-933b-4dd6cc666c5a",
"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-09-18T01:52:52.5753233+00:00"
},
"modified_dateutc": "2026-09-18T01:52:52.5753233+00:00"
},
"equipment_model_id": "6798e875-594c-4ac3-97eb-31e53a94b1c0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c011da7b-fa53-4ada-a410-8097a972d3e1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "55fff91e-710d-4146-b6a1-b6edff72b712",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "447a2f28-25ea-48cf-91a5-aa65438b8eaf",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "50dfcaff-bd42-4bde-9a9b-487cf9930bfa",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8a4ab066-150a-45af-8372-bdb40a03000d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13f8b166-4dfb-4048-a550-8a13fe526628",
"db_currency_id": "04894dc2-a65e-4216-ac16-6696d6dbadb5",
"db_language_id": "bbde8d9d-2c69-4c11-933b-4dd6cc666c5a",
"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-09-18T01:52:52.5753233+00:00"
},
"modified_dateutc": "2026-09-18T01:52:52.5753233+00:00"
},
"equipment_family_id": "d38c99a7-0afd-40e6-a2dd-8ca0d8f729cb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "68e7ad5d-5d64-43c4-9096-8cae63de349e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "78eb5e32-ec7c-4340-bf16-3167fc79ae11",
"_parent_code": "sample string 6",
"sales_organization_id": "0a4536de-7970-4eaf-a922-773d79f80b32",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8a4ab066-150a-45af-8372-bdb40a03000d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13f8b166-4dfb-4048-a550-8a13fe526628",
"db_currency_id": "04894dc2-a65e-4216-ac16-6696d6dbadb5",
"db_language_id": "bbde8d9d-2c69-4c11-933b-4dd6cc666c5a",
"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-09-18T01:52:52.5753233+00:00"
},
"modified_dateutc": "2026-09-18T01:52:52.5753233+00:00"
},
"date_in_production_since": "2026-09-18T01:52:52.5753233+00:00",
"date_out_of_production_since": "2026-09-18T01:52:52.5753233+00:00",
"date_end_support": "2026-09-18T01:52:52.5753233+00:00",
"sales_organization_id": "841b812d-055e-4160-9c03-adee5cc91c61",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8a4ab066-150a-45af-8372-bdb40a03000d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13f8b166-4dfb-4048-a550-8a13fe526628",
"db_currency_id": "04894dc2-a65e-4216-ac16-6696d6dbadb5",
"db_language_id": "bbde8d9d-2c69-4c11-933b-4dd6cc666c5a",
"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-09-18T01:52:52.5753233+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-09-18T01:52:52.5753233+00:00"
},
"project_status_id": "56481126-e954-43e4-86ad-894e5be2ffd2",
"project_status_code": "sample string 10",
"project_status": {
"id": "679ee5e1-3a38-4f5a-94c2-55e4c3a8dcfe",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "05175a6d-c6af-4c00-826a-0689683649e3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8a4ab066-150a-45af-8372-bdb40a03000d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13f8b166-4dfb-4048-a550-8a13fe526628",
"db_currency_id": "04894dc2-a65e-4216-ac16-6696d6dbadb5",
"db_language_id": "bbde8d9d-2c69-4c11-933b-4dd6cc666c5a",
"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-09-18T01:52:52.5753233+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-18T01:52:52.5753233+00:00"
},
"company_id": "af2378a6-0edd-4fa5-bedf-a20651df8e2f",
"company_code": "sample string 12",
"db_address_id": "8916e5f8-3816-4fbb-8753-8fd1d2917b66",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "102b57b7-8d78-4ca6-9a79-01907caee2b8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f0ac302b-d532-471f-8b10-8c063fdbd160",
"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-09-18T01:52:52.5753233+00:00",
"date_create": "2026-09-18T01:52:52.5753233+00:00",
"date_update": "2026-09-18T01:52:52.5753233+00:00",
"updated_by_user_id": "3b44d2c1-f6e2-4df2-807e-6e183e47837c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-18T01:52:52.5753233+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-09-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-18T01:52:52.5753233+00:00",
"date_last_job": "2026-09-18T01:52:52.5753233+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-18T01:52:52.5753233+00:00",
"modified_dateutc": "2026-09-18T01:52:52.5753233+00:00",
"is_mobile_installation": true
},
"job_type_id": "fd044524-949e-4d09-9e5f-98aa7cefba6a",
"job_type_code": "sample string 7",
"job_type": {
"id": "48214cc4-bf0a-4290-887d-04b65827c8fb",
"name": "sample string 2",
"sales_organization_id": "4dfb6ef9-b678-46aa-b964-9b040ed8ba51",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-18T01:52:52.5753233+00:00",
"code": "sample string 7"
},
"job_priority_id": "dc52a067-1801-4903-a0d4-89f63707efa0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f770e8f4-c0ca-40c1-8f0f-4880e3396be0",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1c21ff3f-a15d-49e5-85ed-771e624d75c9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8a4ab066-150a-45af-8372-bdb40a03000d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13f8b166-4dfb-4048-a550-8a13fe526628",
"db_currency_id": "04894dc2-a65e-4216-ac16-6696d6dbadb5",
"db_language_id": "bbde8d9d-2c69-4c11-933b-4dd6cc666c5a",
"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-09-18T01:52:52.5753233+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-18T01:52:52.5753233+00:00"
},
"job_status_id": "cf632b90-67e6-40eb-aa7a-4a785b23c593",
"job_status_code": "sample string 11",
"db_address_id": "4473f343-5013-4fc4-9a9a-7b4d684f75df",
"contact_id": "3f3cc6e0-7f74-4f1b-8a5a-c89ec7b6692f",
"requested_by_company_id": "cf4228a6-3eef-4816-a56a-e29746ecb8e4",
"requested_by_contact_id": "fec78d28-95bf-4d41-be8b-9a74d7462885",
"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-09-18T01:52:52.5753233+00:00",
"due_date": "2026-09-18T01:52:52.5753233+00:00",
"date_create": "2026-09-18T01:52:52.5753233+00:00",
"date_update": "2026-09-18T01:52:52.5753233+00:00",
"date_closed": "2026-09-18T01:52:52.5753233+00:00",
"suggested_user_id": "066ebbbe-d482-4b4a-9a83-f7848dcee61c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "67f93496-1744-4780-8e5d-165ab847fd6b",
"db_language_id": "a6c4e7b4-3355-42fc-acda-377dc4bb1321",
"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-09-18T01:52:52.5753233+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "018166d6-bca2-4d2d-afc3-0af3ec0d3ab9",
"sales_organization": {
"id": "8a4ab066-150a-45af-8372-bdb40a03000d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13f8b166-4dfb-4048-a550-8a13fe526628",
"db_currency_id": "04894dc2-a65e-4216-ac16-6696d6dbadb5",
"db_language_id": "bbde8d9d-2c69-4c11-933b-4dd6cc666c5a",
"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-09-18T01:52:52.5753233+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7138e31d-f9ac-4050-ba31-a4641fc42345",
"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": "60e21e18-a3f3-42b7-9823-8faa51677e13",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-18T01:52:52.5753233+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b077eccc-35b2-4a7d-ad20-847425e12d20"
},
"suggested_date_start": "2026-09-18T01:52:52.5753233+00:00",
"skill_id": "3db1af78-6b87-4e3f-a815-ff82089f2083",
"skill_code": "sample string 32",
"skill": {
"id": "739ec34e-bdcf-4a4c-875e-5a0edd3dd357",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "64810963-8157-4674-b01d-738b79b8ec8c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8a4ab066-150a-45af-8372-bdb40a03000d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "13f8b166-4dfb-4048-a550-8a13fe526628",
"db_currency_id": "04894dc2-a65e-4216-ac16-6696d6dbadb5",
"db_language_id": "bbde8d9d-2c69-4c11-933b-4dd6cc666c5a",
"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-09-18T01:52:52.5753233+00:00"
},
"modified_dateutc": "2026-09-18T01:52:52.5753233+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f8613252-5c2c-4374-9d37-ea1ee15a9e80",
"date_reported_by_company": "2026-09-18T01:52:52.5753233+00:00",
"id2": 36,
"company_id": "9f3f8773-e16c-428f-bde7-aa3abe41a013",
"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": "0b573bac-fa05-4f64-a9f9-725d8f845f0a",
"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-09-18T01:52:52.5753233+00:00"
},
"work_instruction_details_id": "682aa2ac-f39c-4f94-bab0-2c16e428ac56",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "38b46cb6-cff2-4693-85f0-a215b60adf3c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0848295d-57af-41f1-89f5-ef5c134bb152",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-18T01:52:52.5753233+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": "7bffcf6a-3de4-4610-9cba-fcfac41e1973",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-18T01:52:52.5753233+00:00"
}