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": "f23bc7d9-906d-48da-b809-e1296055caef",
"jobs_id": "0daf026b-aaad-4460-9df1-ef61021f57f0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "775327cb-62a6-40a2-8016-f8daa0655de0",
"_parent_id": "4edb7807-0f93-4639-8d06-625a01dcb210",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "30e6c672-a4a0-4384-ae7d-e1d89902f5b2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4bf9578d-e970-4b72-81cf-0ecafab491a5",
"_parent_id": "933a97cc-3fcb-4bbe-b0ea-898b265e7dfa",
"root_parent_id": "5cff581d-3ae8-41fe-bbe5-013488acffcd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ae0ebc16-b6b4-4ac1-a918-68605e69df32",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "877df9c8-2333-4be4-8caa-5c634402defc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "72e2f258-0178-4d9f-96c7-3a2d62dfab93",
"_parent_code": "sample string 6",
"sales_organization_id": "5bc10619-f3c4-46f5-ad6d-6faf7296e21c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "26a2dadf-5097-49ee-a737-49903cec82da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "21db0c02-0d64-418a-adf6-1ddc2a48672a",
"db_currency_id": "2b164ded-dbc8-4ac4-ab83-b3fe5e4b6b46",
"db_language_id": "97f98870-c62c-4eac-9596-8874c633f023",
"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-17T09:26:53.4995739+00:00"
},
"modified_dateutc": "2026-07-17T09:26:53.4995739+00:00"
},
"equipment_model_id": "0e1e118a-63f9-4ac0-920b-bc1b19ac8adf",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6e16a2aa-98d2-48b4-b4f2-42ad034bbcb6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "eaf9fdef-5d4e-4373-8b16-5a12aabec155",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1096efea-2bf5-4adc-8b32-89839676287f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c7c26103-fae9-4ba7-ba82-809888e031ad",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "26a2dadf-5097-49ee-a737-49903cec82da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "21db0c02-0d64-418a-adf6-1ddc2a48672a",
"db_currency_id": "2b164ded-dbc8-4ac4-ab83-b3fe5e4b6b46",
"db_language_id": "97f98870-c62c-4eac-9596-8874c633f023",
"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-17T09:26:53.4995739+00:00"
},
"modified_dateutc": "2026-07-17T09:26:53.4995739+00:00"
},
"equipment_family_id": "715ef344-d784-4510-a5fb-0dadc7bf9096",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "877df9c8-2333-4be4-8caa-5c634402defc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "72e2f258-0178-4d9f-96c7-3a2d62dfab93",
"_parent_code": "sample string 6",
"sales_organization_id": "5bc10619-f3c4-46f5-ad6d-6faf7296e21c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "26a2dadf-5097-49ee-a737-49903cec82da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "21db0c02-0d64-418a-adf6-1ddc2a48672a",
"db_currency_id": "2b164ded-dbc8-4ac4-ab83-b3fe5e4b6b46",
"db_language_id": "97f98870-c62c-4eac-9596-8874c633f023",
"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-17T09:26:53.4995739+00:00"
},
"modified_dateutc": "2026-07-17T09:26:53.4995739+00:00"
},
"date_in_production_since": "2026-07-17T09:26:53.4995739+00:00",
"date_out_of_production_since": "2026-07-17T09:26:53.4995739+00:00",
"date_end_support": "2026-07-17T09:26:53.4995739+00:00",
"sales_organization_id": "424c2185-8a15-45c0-8d65-47376a7d8e10",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "26a2dadf-5097-49ee-a737-49903cec82da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "21db0c02-0d64-418a-adf6-1ddc2a48672a",
"db_currency_id": "2b164ded-dbc8-4ac4-ab83-b3fe5e4b6b46",
"db_language_id": "97f98870-c62c-4eac-9596-8874c633f023",
"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-17T09:26:53.4995739+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-17T09:26:53.4995739+00:00"
},
"project_status_id": "518d0231-9c34-4940-b1c6-c5410ea691ce",
"project_status_code": "sample string 10",
"project_status": {
"id": "bd6fc88a-c577-4287-973a-3af9a9411deb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "95f8739d-ded3-4cc6-ba0f-c228fe6bda26",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "26a2dadf-5097-49ee-a737-49903cec82da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "21db0c02-0d64-418a-adf6-1ddc2a48672a",
"db_currency_id": "2b164ded-dbc8-4ac4-ab83-b3fe5e4b6b46",
"db_language_id": "97f98870-c62c-4eac-9596-8874c633f023",
"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-17T09:26:53.4995739+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-17T09:26:53.4995739+00:00"
},
"company_id": "63f32be2-b234-46b3-a0aa-02c35896edea",
"company_code": "sample string 12",
"db_address_id": "1790152e-1b7d-41b2-92a1-97c5ec71a691",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c12577c5-8b7c-4546-9098-92365289df83",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0aa35fa7-e9cc-4703-8a82-36e3b8e01ad9",
"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-17T09:26:53.4995739+00:00",
"date_create": "2026-07-17T09:26:53.4995739+00:00",
"date_update": "2026-07-17T09:26:53.4995739+00:00",
"updated_by_user_id": "b3a38815-fe6d-48fd-9c65-641bae2ffd4a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-17T09:26:53.4995739+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-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-17T09:26:53.4995739+00:00",
"date_last_job": "2026-07-17T09:26:53.4995739+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-17T09:26:53.4995739+00:00",
"modified_dateutc": "2026-07-17T09:26:53.4995739+00:00",
"is_mobile_installation": true
},
"job_type_id": "eafca089-5642-4ba4-a9c8-9fa06e261596",
"job_type_code": "sample string 7",
"job_type": {
"id": "213dccf8-f33a-4861-aff6-4853787f415a",
"name": "sample string 2",
"sales_organization_id": "716cbba4-3f8a-4ea4-9df5-db50a0e8726b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-17T09:26:53.4995739+00:00",
"code": "sample string 7"
},
"job_priority_id": "3f5f4514-1ad3-45b6-b821-61f0566b3316",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9ed9ada2-ab4a-43a3-886f-910950ae27ef",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4b3af3b2-7349-47c9-9cbc-f83754ad37a2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "26a2dadf-5097-49ee-a737-49903cec82da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "21db0c02-0d64-418a-adf6-1ddc2a48672a",
"db_currency_id": "2b164ded-dbc8-4ac4-ab83-b3fe5e4b6b46",
"db_language_id": "97f98870-c62c-4eac-9596-8874c633f023",
"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-17T09:26:53.4995739+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-17T09:26:53.4995739+00:00"
},
"job_status_id": "c2d8afa7-9b02-4f6e-944d-e749d5efcb49",
"job_status_code": "sample string 11",
"db_address_id": "9b5fefbc-62a1-4a01-9219-b108f71841c3",
"contact_id": "f1aa84b9-bad8-41c0-aab5-a88d10343834",
"requested_by_company_id": "31c22452-1718-4cfa-9756-3e2754cabcd9",
"requested_by_contact_id": "f94e81c4-1469-466f-88c5-851e902e1b59",
"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-17T09:26:53.4995739+00:00",
"due_date": "2026-07-17T09:26:53.4995739+00:00",
"date_create": "2026-07-17T09:26:53.4995739+00:00",
"date_update": "2026-07-17T09:26:53.4995739+00:00",
"date_closed": "2026-07-17T09:26:53.4995739+00:00",
"suggested_user_id": "935c01dc-6a67-4385-9520-8ff8affce1ad",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d3ae793e-5cf8-45eb-b4c6-fbdffd2a4040",
"db_language_id": "29752bde-8bd4-4fbf-bb43-134eca289ddf",
"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-17T09:26:53.4995739+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6e1b95c2-373b-48b6-a9e8-097b5345dd47",
"sales_organization": {
"id": "26a2dadf-5097-49ee-a737-49903cec82da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "21db0c02-0d64-418a-adf6-1ddc2a48672a",
"db_currency_id": "2b164ded-dbc8-4ac4-ab83-b3fe5e4b6b46",
"db_language_id": "97f98870-c62c-4eac-9596-8874c633f023",
"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-17T09:26:53.4995739+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "956f9b48-5432-49e0-99ea-bf1dd89682bd",
"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": "25157994-e62e-4ec1-9ed9-c3778c3e4270",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-17T09:26:53.4995739+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1fac4b08-eea6-431a-baec-094a4e281328"
},
"suggested_date_start": "2026-07-17T09:26:53.4995739+00:00",
"skill_id": "87db5d9d-7252-42f0-a0bc-129f44593d92",
"skill_code": "sample string 32",
"skill": {
"id": "b2c1d5e2-46da-4885-affe-5327bcccffb3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ac0ca27d-5e38-44b2-93e9-32d2d92cf5ba",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "26a2dadf-5097-49ee-a737-49903cec82da",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "21db0c02-0d64-418a-adf6-1ddc2a48672a",
"db_currency_id": "2b164ded-dbc8-4ac4-ab83-b3fe5e4b6b46",
"db_language_id": "97f98870-c62c-4eac-9596-8874c633f023",
"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-17T09:26:53.4995739+00:00"
},
"modified_dateutc": "2026-07-17T09:26:53.4995739+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "60a8dd29-0fd4-4ed2-b6ad-969989bc9067",
"date_reported_by_company": "2026-07-17T09:26:53.4995739+00:00",
"id2": 36,
"company_id": "be543805-a6b1-4b98-b026-88a7fde8a3de",
"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": "05cc1086-1826-43c4-b674-11035435f912",
"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-17T09:26:53.4995739+00:00"
},
"work_instruction_details_id": "42ce7886-7be9-41c0-b6bb-93182aa08f2a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "16dd0e8f-d014-4ad6-be11-d56af57fe9c8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5bb0a0fb-5f9c-4623-8b88-e36b2bb6c293",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-17T09:26:53.4995739+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": "8e33c0af-95e6-49b2-ae5a-c76d5b991fbd",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-17T09:26:53.4995739+00:00"
}