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": "aac3ee12-a3f3-4d1f-92d8-6a01454aa695",
"jobs_id": "2badb355-b392-461b-8149-f449553c65b2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "db4eeb25-6557-4b9a-9b33-6a61118c1116",
"_parent_id": "108da603-1e7e-426d-b231-4dcb7ee65c60",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a3133083-a494-43bd-a50b-c32d207df6fc",
"project_reference_back_office": "sample string 5",
"project": {
"id": "dcc216e0-25b5-42f7-b026-6594e14fdadb",
"_parent_id": "adf76e7c-1fc5-461e-a400-b5a0b8c7dd38",
"root_parent_id": "96d0389f-b067-4fca-b8c4-100e677111fc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0d36e4a8-db96-4f60-8a13-8e3728929276",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f1731b65-6661-420b-85eb-4366bc18d077",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c1336eb3-054a-4a21-8ad6-3f6d0bd40180",
"_parent_code": "sample string 6",
"sales_organization_id": "1a68a8d6-11bc-4f31-8f2c-077482f3ea1d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "00743d00-c3c6-4a2d-aeb6-e764113ab1fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbfefc73-42c3-43ec-a11c-8b8726457683",
"db_currency_id": "01036535-5f7c-426a-9c21-3409db274b2b",
"db_language_id": "a318375f-4c2e-4a31-8925-63b448b1b4ed",
"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-11-10T14:50:34.3641225+00:00"
},
"modified_dateutc": "2026-11-10T14:50:34.3641225+00:00"
},
"equipment_model_id": "8450fdc3-6cb2-4a33-9b7d-a346ce1e6e3e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "633428c4-3dd9-45eb-b808-6c4e49620d07",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ec1eca27-325e-4dec-a4b9-6ab841042ca2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b6d168a9-b4f0-40dc-8195-9fb793f50311",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "df852c23-5292-4074-b53f-64b7eb2bc3d9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "00743d00-c3c6-4a2d-aeb6-e764113ab1fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbfefc73-42c3-43ec-a11c-8b8726457683",
"db_currency_id": "01036535-5f7c-426a-9c21-3409db274b2b",
"db_language_id": "a318375f-4c2e-4a31-8925-63b448b1b4ed",
"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-11-10T14:50:34.3641225+00:00"
},
"modified_dateutc": "2026-11-10T14:50:34.3641225+00:00"
},
"equipment_family_id": "38120df1-a04d-4067-816d-903997d91db7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f1731b65-6661-420b-85eb-4366bc18d077",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c1336eb3-054a-4a21-8ad6-3f6d0bd40180",
"_parent_code": "sample string 6",
"sales_organization_id": "1a68a8d6-11bc-4f31-8f2c-077482f3ea1d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "00743d00-c3c6-4a2d-aeb6-e764113ab1fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbfefc73-42c3-43ec-a11c-8b8726457683",
"db_currency_id": "01036535-5f7c-426a-9c21-3409db274b2b",
"db_language_id": "a318375f-4c2e-4a31-8925-63b448b1b4ed",
"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-11-10T14:50:34.3641225+00:00"
},
"modified_dateutc": "2026-11-10T14:50:34.3641225+00:00"
},
"date_in_production_since": "2026-11-10T14:50:34.3641225+00:00",
"date_out_of_production_since": "2026-11-10T14:50:34.3641225+00:00",
"date_end_support": "2026-11-10T14:50:34.3641225+00:00",
"sales_organization_id": "11fa2e51-2713-4d49-8e53-05f0376817fa",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "00743d00-c3c6-4a2d-aeb6-e764113ab1fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbfefc73-42c3-43ec-a11c-8b8726457683",
"db_currency_id": "01036535-5f7c-426a-9c21-3409db274b2b",
"db_language_id": "a318375f-4c2e-4a31-8925-63b448b1b4ed",
"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-11-10T14:50:34.3641225+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-11-10T14:50:34.3641225+00:00"
},
"project_status_id": "e89bf1f6-498e-4b9c-a15e-c4a78d7e7a58",
"project_status_code": "sample string 10",
"project_status": {
"id": "b0cb3993-d255-4a8b-94c5-e5067dc94a72",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8d6c3c00-1554-4589-9133-769741fcd36b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "00743d00-c3c6-4a2d-aeb6-e764113ab1fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbfefc73-42c3-43ec-a11c-8b8726457683",
"db_currency_id": "01036535-5f7c-426a-9c21-3409db274b2b",
"db_language_id": "a318375f-4c2e-4a31-8925-63b448b1b4ed",
"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-11-10T14:50:34.3641225+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-10T14:50:34.3641225+00:00"
},
"company_id": "24d8083c-d5eb-460b-a5f9-3d4fdaf558fa",
"company_code": "sample string 12",
"db_address_id": "ccd9c4ca-e74d-4f57-bb34-17cc4cd15a50",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1282fb02-f8e2-4bf4-a1f5-e485b78c29e5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4615381e-d123-49b3-82f0-9e4db9578b1f",
"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-11-10T14:50:34.3641225+00:00",
"date_create": "2026-11-10T14:50:34.3641225+00:00",
"date_update": "2026-11-10T14:50:34.3641225+00:00",
"updated_by_user_id": "3fe818bb-37cc-41d2-b221-c474efa18b90",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-10T14:50:34.3641225+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-11-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-10T14:50:34.3641225+00:00",
"date_last_job": "2026-11-10T14:50:34.3641225+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-10T14:50:34.3641225+00:00",
"modified_dateutc": "2026-11-10T14:50:34.3641225+00:00",
"is_mobile_installation": true
},
"job_type_id": "bcc5d15c-1ce1-4552-a4e4-d236853a9fa6",
"job_type_code": "sample string 7",
"job_type": {
"id": "2898caf8-1c82-48c7-aa41-78bd281aaaf8",
"name": "sample string 2",
"sales_organization_id": "063a0f82-4b4c-483d-b231-4a969d13f72d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-10T14:50:34.3641225+00:00",
"code": "sample string 7"
},
"job_priority_id": "05e3a5eb-938b-4800-b35c-66d13333d777",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "40b85f6d-dc88-485e-b05d-51435badf273",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b23f2e5a-864e-4d0f-a51d-caa2a1644832",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "00743d00-c3c6-4a2d-aeb6-e764113ab1fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbfefc73-42c3-43ec-a11c-8b8726457683",
"db_currency_id": "01036535-5f7c-426a-9c21-3409db274b2b",
"db_language_id": "a318375f-4c2e-4a31-8925-63b448b1b4ed",
"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-11-10T14:50:34.3641225+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-10T14:50:34.3749755+00:00"
},
"job_status_id": "4e2d5a62-4bf7-4122-bb97-ca660387bc59",
"job_status_code": "sample string 11",
"db_address_id": "a64a50b4-aff4-45a6-8626-767e5f65224a",
"contact_id": "8086f54c-1572-4ca3-bca7-c42ca527505d",
"requested_by_company_id": "d802648b-f1cf-43d8-b588-24a1b0a794cf",
"requested_by_contact_id": "ff2400f4-e00d-4fba-b14b-de475c56f7ff",
"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-11-10T14:50:34.3749755+00:00",
"due_date": "2026-11-10T14:50:34.3749755+00:00",
"date_create": "2026-11-10T14:50:34.3749755+00:00",
"date_update": "2026-11-10T14:50:34.3749755+00:00",
"date_closed": "2026-11-10T14:50:34.3749755+00:00",
"suggested_user_id": "41d2e316-ab63-4f47-b602-cb421f1dc48a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ec327076-3131-41e7-a2b6-152aa20cb13b",
"db_language_id": "d9ee2325-4ae0-479c-9524-a4d9f4cf2bf9",
"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-11-10T14:50:34.3749755+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0035b5cb-6f77-481c-993d-fe6b2e724255",
"sales_organization": {
"id": "00743d00-c3c6-4a2d-aeb6-e764113ab1fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbfefc73-42c3-43ec-a11c-8b8726457683",
"db_currency_id": "01036535-5f7c-426a-9c21-3409db274b2b",
"db_language_id": "a318375f-4c2e-4a31-8925-63b448b1b4ed",
"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-11-10T14:50:34.3641225+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "08725ce1-8394-4595-bee5-7d912e735e12",
"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": "ce083305-3ece-4e8f-aee3-cac57da26ab1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-10T14:50:34.3749755+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7435da97-db5a-470e-936a-6517888e202f"
},
"suggested_date_start": "2026-11-10T14:50:34.3749755+00:00",
"skill_id": "c8f87dcf-dcf0-466c-ad88-36e2effffcd0",
"skill_code": "sample string 32",
"skill": {
"id": "e40efa10-cce5-4c7c-8295-a7c38c134100",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f9c267ad-1f65-4419-906b-0acfea86cb95",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "00743d00-c3c6-4a2d-aeb6-e764113ab1fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bbfefc73-42c3-43ec-a11c-8b8726457683",
"db_currency_id": "01036535-5f7c-426a-9c21-3409db274b2b",
"db_language_id": "a318375f-4c2e-4a31-8925-63b448b1b4ed",
"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-11-10T14:50:34.3641225+00:00"
},
"modified_dateutc": "2026-11-10T14:50:34.3749755+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "396e60c7-4bba-42d4-a614-eeb3dc5e18b3",
"date_reported_by_company": "2026-11-10T14:50:34.3749755+00:00",
"id2": 36,
"company_id": "644cecf8-a34a-47b4-a42f-690eaa2d52d2",
"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": "2d44489e-5186-441b-b22c-7664b5875224",
"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-11-10T14:50:34.3749755+00:00"
},
"work_instruction_details_id": "965a6d2c-1655-48cf-af36-9b81a373ca4f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cbfb204f-f424-428a-a4f3-8364b568c16c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "409cc2d5-380b-4913-b849-6a61646d1f18",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-10T14:50:34.3749755+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": "3299358b-4a6f-4018-a3c5-e96e2c04bd24",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-10T14:50:34.3749755+00:00"
}