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": "df952720-226f-43b9-916e-847d37f0fca6",
"jobs_id": "c6a518e5-ba7f-42c3-8a2f-ca7e8cde314f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6afcd1fb-6434-45f1-b8a8-c510bf751daa",
"_parent_id": "db52a193-2382-45f8-ad8c-2252b911ca94",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5bab874f-e5c0-4944-80dd-170f29b55244",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c317fffe-7093-42de-be9f-2f9014a6a6e6",
"_parent_id": "6a7bc8cb-410c-41ee-848c-636ccf32736b",
"root_parent_id": "82b1492d-3984-406a-98b3-8bca0b2612e0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "395283ce-4582-4c20-8ad8-64d374f430ec",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b76e9e6e-1d71-4208-a41c-99ba2364c683",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4aca8e58-79aa-43a0-b2f2-19f37dafa8ed",
"_parent_code": "sample string 6",
"sales_organization_id": "b595deaf-24ce-4009-90d8-018e8f7a2204",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a1bb9e3c-c31e-4876-b08b-0f0ecb983af9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcbc2d54-c972-436b-b0b3-359a4c14e394",
"db_currency_id": "04097360-0818-462e-8a7c-d8e14b2be1b2",
"db_language_id": "a3c16413-876e-486e-9e19-6a87402387a4",
"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-01-15T10:47:53.9565566+00:00"
},
"modified_dateutc": "2026-01-15T10:47:53.9565566+00:00"
},
"equipment_model_id": "de9662e2-9e61-408e-a98d-a955f027e585",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "228ff81e-56a1-4db5-9026-6fc43725ac9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b309cc63-b032-4e53-9038-adb113a18682",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8d886da8-9ae8-401b-9294-2cc0a129d35e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0c9a103a-d7b0-4390-bdb6-1c6d8a7c964f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a1bb9e3c-c31e-4876-b08b-0f0ecb983af9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcbc2d54-c972-436b-b0b3-359a4c14e394",
"db_currency_id": "04097360-0818-462e-8a7c-d8e14b2be1b2",
"db_language_id": "a3c16413-876e-486e-9e19-6a87402387a4",
"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-01-15T10:47:53.9565566+00:00"
},
"modified_dateutc": "2026-01-15T10:47:53.9721786+00:00"
},
"equipment_family_id": "a772ff98-9806-479f-bbd0-20fc2a5cbda2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b76e9e6e-1d71-4208-a41c-99ba2364c683",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4aca8e58-79aa-43a0-b2f2-19f37dafa8ed",
"_parent_code": "sample string 6",
"sales_organization_id": "b595deaf-24ce-4009-90d8-018e8f7a2204",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a1bb9e3c-c31e-4876-b08b-0f0ecb983af9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcbc2d54-c972-436b-b0b3-359a4c14e394",
"db_currency_id": "04097360-0818-462e-8a7c-d8e14b2be1b2",
"db_language_id": "a3c16413-876e-486e-9e19-6a87402387a4",
"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-01-15T10:47:53.9565566+00:00"
},
"modified_dateutc": "2026-01-15T10:47:53.9565566+00:00"
},
"date_in_production_since": "2026-01-15T10:47:53.9721786+00:00",
"date_out_of_production_since": "2026-01-15T10:47:53.9721786+00:00",
"date_end_support": "2026-01-15T10:47:53.9721786+00:00",
"sales_organization_id": "189cb599-7ed2-47ef-b172-30e736caa045",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a1bb9e3c-c31e-4876-b08b-0f0ecb983af9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcbc2d54-c972-436b-b0b3-359a4c14e394",
"db_currency_id": "04097360-0818-462e-8a7c-d8e14b2be1b2",
"db_language_id": "a3c16413-876e-486e-9e19-6a87402387a4",
"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-01-15T10:47:53.9565566+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-01-15T10:47:53.9721786+00:00"
},
"project_status_id": "fc721bae-127e-428d-8091-53c6f0132163",
"project_status_code": "sample string 10",
"project_status": {
"id": "1fcf571c-31da-41f3-915a-5b5744c3fedf",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2455f48e-c0bf-42b7-97d8-decb5d737e06",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a1bb9e3c-c31e-4876-b08b-0f0ecb983af9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcbc2d54-c972-436b-b0b3-359a4c14e394",
"db_currency_id": "04097360-0818-462e-8a7c-d8e14b2be1b2",
"db_language_id": "a3c16413-876e-486e-9e19-6a87402387a4",
"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-01-15T10:47:53.9565566+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-15T10:47:53.9721786+00:00"
},
"company_id": "9a7c9313-64f8-4e00-8f65-05a832c1fe31",
"company_code": "sample string 12",
"db_address_id": "0f5b4b14-191a-4b30-a9cc-bf1b53d85c90",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7b7e5e28-47d3-417a-b13a-4e36dd1b00d0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7eb930e1-1131-4193-be95-217e73727c8d",
"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-01-15T10:47:53.9721786+00:00",
"date_create": "2026-01-15T10:47:53.9721786+00:00",
"date_update": "2026-01-15T10:47:53.9721786+00:00",
"updated_by_user_id": "ceff20d1-e83c-483c-ad75-acd800eb9ca1",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-15T10:47:53.9721786+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-01-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-15T10:47:53.9721786+00:00",
"date_last_job": "2026-01-15T10:47:53.9721786+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-15T10:47:53.9721786+00:00",
"modified_dateutc": "2026-01-15T10:47:53.9721786+00:00",
"is_mobile_installation": true
},
"job_type_id": "d5de7093-a7b0-46d5-9d05-062ff08bb164",
"job_type_code": "sample string 7",
"job_type": {
"id": "470665f3-1ffc-409b-8e25-a4bf1e5431c8",
"name": "sample string 2",
"sales_organization_id": "5f9c04ee-a01b-48b6-bcde-4eed59e285a8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-15T10:47:53.9721786+00:00",
"code": "sample string 7"
},
"job_priority_id": "543f9a42-139d-443e-aeef-0bc2454ace94",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "06ac81e6-7b1d-40ba-8952-48d1a8d46d27",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "bc10d914-7131-4fbb-af11-69aaf415aa12",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a1bb9e3c-c31e-4876-b08b-0f0ecb983af9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcbc2d54-c972-436b-b0b3-359a4c14e394",
"db_currency_id": "04097360-0818-462e-8a7c-d8e14b2be1b2",
"db_language_id": "a3c16413-876e-486e-9e19-6a87402387a4",
"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-01-15T10:47:53.9565566+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-15T10:47:53.9721786+00:00"
},
"job_status_id": "5ae2e953-1758-4f2b-9072-5ba15241ba89",
"job_status_code": "sample string 11",
"db_address_id": "0808ff81-5c11-4603-b2b9-a93cf892d87c",
"contact_id": "89cbe025-932d-4c15-bbf6-2f17217c6f1c",
"requested_by_company_id": "312cc9fd-963c-4fd3-8889-a747fbf1b83d",
"requested_by_contact_id": "e15764f2-5956-4b5f-af60-9687d3833c82",
"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-01-15T10:47:53.9721786+00:00",
"due_date": "2026-01-15T10:47:53.9721786+00:00",
"date_create": "2026-01-15T10:47:53.9721786+00:00",
"date_update": "2026-01-15T10:47:53.9721786+00:00",
"date_closed": "2026-01-15T10:47:53.9721786+00:00",
"suggested_user_id": "1e4d324d-3254-479c-b861-04511de9be4c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9f6d6297-e36b-41bc-bf10-20f2c0b503ad",
"db_language_id": "009d9e9f-0752-4d61-8ca2-0f3c1b22ebe9",
"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-01-15T10:47:53.9721786+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9b97c7cd-8997-4346-8027-d6dc81db3aec",
"sales_organization": {
"id": "a1bb9e3c-c31e-4876-b08b-0f0ecb983af9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcbc2d54-c972-436b-b0b3-359a4c14e394",
"db_currency_id": "04097360-0818-462e-8a7c-d8e14b2be1b2",
"db_language_id": "a3c16413-876e-486e-9e19-6a87402387a4",
"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-01-15T10:47:53.9565566+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "168b0226-66a6-4e0c-a96b-1eeddfd1b717",
"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": "e2bc28e6-7758-4869-8404-341ff446d2b3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-15T10:47:53.9721786+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "52e07f4b-117d-4ade-bddd-525ef4cff7fc"
},
"suggested_date_start": "2026-01-15T10:47:53.9721786+00:00",
"skill_id": "d4b8e201-c09b-4169-8c9e-cbb2eb038d6a",
"skill_code": "sample string 32",
"skill": {
"id": "bc228e63-458e-498f-85d1-2c8539dd4358",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ce24499c-a6d6-4464-83a0-dc2097f9309c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a1bb9e3c-c31e-4876-b08b-0f0ecb983af9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "dcbc2d54-c972-436b-b0b3-359a4c14e394",
"db_currency_id": "04097360-0818-462e-8a7c-d8e14b2be1b2",
"db_language_id": "a3c16413-876e-486e-9e19-6a87402387a4",
"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-01-15T10:47:53.9565566+00:00"
},
"modified_dateutc": "2026-01-15T10:47:53.9721786+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "dc87aa56-44f2-4501-a2fd-d4e0a66d0c09",
"date_reported_by_company": "2026-01-15T10:47:53.9721786+00:00",
"id2": 36,
"company_id": "a138fd92-0808-4150-b5b4-5296ccb9cdd5",
"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": "9ce22a9b-414a-46aa-b515-92911172c18a",
"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-01-15T10:47:53.9721786+00:00"
},
"work_instruction_details_id": "228069da-1522-4d7a-b1af-61b4d65c72f0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7af3a971-5aaa-4a36-8953-b28ca281b724",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0fd626d2-c7dd-485f-bec9-a19bd3eabd14",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-15T10:47:53.9721786+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": "88e16f73-b63e-4c5e-a0b0-930aedeafa79",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-15T10:47:53.9721786+00:00"
}