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": "32c19903-60e6-4a63-adda-2aa2a7bf222c",
"jobs_id": "473d27e5-5064-492f-a52f-9598a6d02718",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9f88fe03-66a3-4122-a726-9e2ee201cd21",
"_parent_id": "cd8486a4-7b41-4172-9ab1-22932dff440e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "eae999e7-f208-432b-9cc6-f24f3cd60861",
"project_reference_back_office": "sample string 5",
"project": {
"id": "89fe6a89-c162-436d-9198-338284e1abcd",
"_parent_id": "2d0931fe-eec1-4ed6-aacd-8e42b0e42f1b",
"root_parent_id": "9ca721cb-21bc-484c-929d-a4833fc43d9a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5e095d83-5112-4c52-9f21-9081097aedf9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "859912df-6053-4010-95a1-d06f96d5160a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c2ce9698-c69b-4333-a706-21da69266fb7",
"_parent_code": "sample string 6",
"sales_organization_id": "f890614f-5c1e-415d-ba3a-63d9ad4f790e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5694f8bd-e048-405b-8c9b-c2dd8ec7155b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49471b01-bf71-4ec0-980a-b76ab34ba693",
"db_currency_id": "4514968a-a2c3-4ed3-af15-f39cf4278b16",
"db_language_id": "869dcee0-5c49-44e0-ab81-e69adc32dd58",
"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-04-18T12:35:02.0678467+00:00"
},
"modified_dateutc": "2026-04-18T12:35:02.0678467+00:00"
},
"equipment_model_id": "17b57ea4-599f-46dd-8673-0b16265f7770",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2cb72170-6504-44b8-a2ad-7a640e1f8320",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0636b569-7754-4bbf-a3f4-16cec439add7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3da548e8-2c27-4915-939a-86daee8940fe",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "90f55599-dda8-48f6-b15f-f486d352ea20",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5694f8bd-e048-405b-8c9b-c2dd8ec7155b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49471b01-bf71-4ec0-980a-b76ab34ba693",
"db_currency_id": "4514968a-a2c3-4ed3-af15-f39cf4278b16",
"db_language_id": "869dcee0-5c49-44e0-ab81-e69adc32dd58",
"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-04-18T12:35:02.0678467+00:00"
},
"modified_dateutc": "2026-04-18T12:35:02.0678467+00:00"
},
"equipment_family_id": "6e25b0bc-c16d-4f3a-8dc5-ec1faac83f24",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "859912df-6053-4010-95a1-d06f96d5160a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c2ce9698-c69b-4333-a706-21da69266fb7",
"_parent_code": "sample string 6",
"sales_organization_id": "f890614f-5c1e-415d-ba3a-63d9ad4f790e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5694f8bd-e048-405b-8c9b-c2dd8ec7155b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49471b01-bf71-4ec0-980a-b76ab34ba693",
"db_currency_id": "4514968a-a2c3-4ed3-af15-f39cf4278b16",
"db_language_id": "869dcee0-5c49-44e0-ab81-e69adc32dd58",
"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-04-18T12:35:02.0678467+00:00"
},
"modified_dateutc": "2026-04-18T12:35:02.0678467+00:00"
},
"date_in_production_since": "2026-04-18T12:35:02.0678467+00:00",
"date_out_of_production_since": "2026-04-18T12:35:02.0678467+00:00",
"date_end_support": "2026-04-18T12:35:02.0678467+00:00",
"sales_organization_id": "853214ed-7029-4052-b468-453aab54eea8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5694f8bd-e048-405b-8c9b-c2dd8ec7155b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49471b01-bf71-4ec0-980a-b76ab34ba693",
"db_currency_id": "4514968a-a2c3-4ed3-af15-f39cf4278b16",
"db_language_id": "869dcee0-5c49-44e0-ab81-e69adc32dd58",
"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-04-18T12:35:02.0678467+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-04-18T12:35:02.0678467+00:00"
},
"project_status_id": "acc617b2-4361-43ba-a286-6e1cdec8de0c",
"project_status_code": "sample string 10",
"project_status": {
"id": "94b4a291-e33c-4768-bca3-3578d63d7ac0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a0b8931b-1f21-492e-b2c4-4bd742b0f35c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5694f8bd-e048-405b-8c9b-c2dd8ec7155b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49471b01-bf71-4ec0-980a-b76ab34ba693",
"db_currency_id": "4514968a-a2c3-4ed3-af15-f39cf4278b16",
"db_language_id": "869dcee0-5c49-44e0-ab81-e69adc32dd58",
"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-04-18T12:35:02.0678467+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-18T12:35:02.0678467+00:00"
},
"company_id": "2212c6f1-7cf8-41ff-99bb-d5ec79e6f4a0",
"company_code": "sample string 12",
"db_address_id": "1ca846c4-c4d1-4e65-aea5-f9443cea0049",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "28af8f6e-b936-46bd-8f0e-fb8a566bfeef",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "94264007-34d7-4316-a91b-c699831f177e",
"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-04-18T12:35:02.0678467+00:00",
"date_create": "2026-04-18T12:35:02.0678467+00:00",
"date_update": "2026-04-18T12:35:02.0678467+00:00",
"updated_by_user_id": "1d638caa-d919-4bfc-a74f-b42cd73e3e01",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-18T12:35:02.0678467+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-04-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-18T12:35:02.0678467+00:00",
"date_last_job": "2026-04-18T12:35:02.0678467+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-18T12:35:02.0678467+00:00",
"modified_dateutc": "2026-04-18T12:35:02.0678467+00:00",
"is_mobile_installation": true
},
"job_type_id": "0ddf0aee-49df-4854-99bd-8f1976b63315",
"job_type_code": "sample string 7",
"job_type": {
"id": "509b6dac-1fec-4894-8351-33c5a17b9f8a",
"name": "sample string 2",
"sales_organization_id": "792c7529-6582-4352-8454-b4015c31cc06",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-18T12:35:02.0834828+00:00",
"code": "sample string 7"
},
"job_priority_id": "bdd700db-c700-4717-9640-d9b065d2aa57",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "51cd11ba-4c36-4a11-b1ff-94cab756ea03",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "458c946e-bc0e-464b-9e6c-9449d3818598",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5694f8bd-e048-405b-8c9b-c2dd8ec7155b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49471b01-bf71-4ec0-980a-b76ab34ba693",
"db_currency_id": "4514968a-a2c3-4ed3-af15-f39cf4278b16",
"db_language_id": "869dcee0-5c49-44e0-ab81-e69adc32dd58",
"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-04-18T12:35:02.0678467+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-18T12:35:02.0834828+00:00"
},
"job_status_id": "63a624ab-9b22-48c9-b9ac-1351190015c8",
"job_status_code": "sample string 11",
"db_address_id": "0dfcf37b-129d-4f7e-9c92-6be0e19c8765",
"contact_id": "21e0e2fd-88ca-4a58-bf95-8ae045063374",
"requested_by_company_id": "a0a297c2-314f-49d4-b5d2-638255ddb79e",
"requested_by_contact_id": "e901077b-68a5-480b-90c5-036b9ab70f1d",
"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-04-18T12:35:02.0834828+00:00",
"due_date": "2026-04-18T12:35:02.0834828+00:00",
"date_create": "2026-04-18T12:35:02.0834828+00:00",
"date_update": "2026-04-18T12:35:02.0834828+00:00",
"date_closed": "2026-04-18T12:35:02.0834828+00:00",
"suggested_user_id": "3dc6e2f6-0333-430d-ad36-4174047b9457",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "64378e7f-c91d-49d5-9682-4b5cad94275f",
"db_language_id": "9bd6e5bc-340f-46c7-95c6-b5b23fe64523",
"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-04-18T12:35:02.0834828+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "13814c5e-d04d-4aad-acf0-8fd04b488082",
"sales_organization": {
"id": "5694f8bd-e048-405b-8c9b-c2dd8ec7155b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49471b01-bf71-4ec0-980a-b76ab34ba693",
"db_currency_id": "4514968a-a2c3-4ed3-af15-f39cf4278b16",
"db_language_id": "869dcee0-5c49-44e0-ab81-e69adc32dd58",
"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-04-18T12:35:02.0678467+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "602fcda1-71df-4368-834e-4b9ac76a8500",
"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": "34a41110-a424-4ed6-8ce8-96cca8eff197",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-18T12:35:02.0834828+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0f61bb3f-6ca4-47d7-8ff9-55f7f90555b0"
},
"suggested_date_start": "2026-04-18T12:35:02.0834828+00:00",
"skill_id": "e0784969-abb3-4389-a08c-1f4ca8b5245d",
"skill_code": "sample string 32",
"skill": {
"id": "9e3666fc-3335-4542-a007-5881232a4eff",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c90a3c97-d794-48b6-a475-3bc691361a76",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5694f8bd-e048-405b-8c9b-c2dd8ec7155b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "49471b01-bf71-4ec0-980a-b76ab34ba693",
"db_currency_id": "4514968a-a2c3-4ed3-af15-f39cf4278b16",
"db_language_id": "869dcee0-5c49-44e0-ab81-e69adc32dd58",
"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-04-18T12:35:02.0678467+00:00"
},
"modified_dateutc": "2026-04-18T12:35:02.0834828+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5588b574-650f-40f0-8af0-3d365556cdcf",
"date_reported_by_company": "2026-04-18T12:35:02.0834828+00:00",
"id2": 36,
"company_id": "19ead7a4-805b-410a-b8c3-16b9f3ea8579",
"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": "5a42b30f-c321-40fc-b34a-67692e32fdda",
"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-04-18T12:35:02.0834828+00:00"
},
"work_instruction_details_id": "f0df6e54-eab9-410a-bf5c-cf8afbdd37af",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "92c89e7f-4fc5-4295-af7f-164aea37b97f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6f04c395-9787-4977-ac4d-c72c97c2308c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-18T12:35:02.0834828+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": "0448a703-e9f5-445b-b413-8aa27dd00683",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-18T12:35:02.0834828+00:00"
}