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": "3c3435ed-3b83-4dcf-a355-257802967ef2",
"jobs_id": "321f1513-41e5-42c3-a2cc-bb5a47ac2408",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b75fa9f3-d718-404a-99e6-6d01ea318590",
"_parent_id": "fbd2a454-e3b9-411a-980d-33f7e2c23127",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "aa1a57ac-2c37-4f08-8306-3b440034374d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ecd0c970-86a6-4205-9e96-5f83e6995f13",
"_parent_id": "d6df5ea6-618d-4ff4-ba58-394550e8e720",
"root_parent_id": "4eb27830-d48f-4016-bdc4-b39a8a9e59c2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9e648eaf-14ff-420b-be33-9d7cf5f52d1f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6908354f-2acb-4037-97d7-f4f126addbfe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2e5e7854-d74c-469f-b967-48b5b0504750",
"_parent_code": "sample string 6",
"sales_organization_id": "d83abbf0-74c3-4ed2-8843-7f5576f48d74",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fe7dd4e1-09a8-4666-af39-b82bde70e2bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0924897b-04dd-4392-b322-495ef99065ec",
"db_currency_id": "beca0cab-e825-4dea-946b-74e036244957",
"db_language_id": "421aba26-6e03-486f-9483-8ee98343cbb0",
"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-08-21T21:37:47.8001096+00:00"
},
"modified_dateutc": "2026-08-21T21:37:47.8001096+00:00"
},
"equipment_model_id": "6c823f7a-9af0-4f1e-bbd5-c08c5fc6d04c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d19aed31-5aad-4aba-8d42-076446e01171",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "855a378d-0769-45b2-923a-141c286045be",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f11448b3-97df-4b7c-b045-b90ea3d576a5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "cdb18f99-2ce0-4ca7-ab31-dda3bd4b5161",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fe7dd4e1-09a8-4666-af39-b82bde70e2bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0924897b-04dd-4392-b322-495ef99065ec",
"db_currency_id": "beca0cab-e825-4dea-946b-74e036244957",
"db_language_id": "421aba26-6e03-486f-9483-8ee98343cbb0",
"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-08-21T21:37:47.8001096+00:00"
},
"modified_dateutc": "2026-08-21T21:37:47.8001096+00:00"
},
"equipment_family_id": "4d9376a4-b681-4baf-8b0c-75bebfd1a409",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6908354f-2acb-4037-97d7-f4f126addbfe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2e5e7854-d74c-469f-b967-48b5b0504750",
"_parent_code": "sample string 6",
"sales_organization_id": "d83abbf0-74c3-4ed2-8843-7f5576f48d74",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fe7dd4e1-09a8-4666-af39-b82bde70e2bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0924897b-04dd-4392-b322-495ef99065ec",
"db_currency_id": "beca0cab-e825-4dea-946b-74e036244957",
"db_language_id": "421aba26-6e03-486f-9483-8ee98343cbb0",
"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-08-21T21:37:47.8001096+00:00"
},
"modified_dateutc": "2026-08-21T21:37:47.8001096+00:00"
},
"date_in_production_since": "2026-08-21T21:37:47.8001096+00:00",
"date_out_of_production_since": "2026-08-21T21:37:47.8001096+00:00",
"date_end_support": "2026-08-21T21:37:47.8001096+00:00",
"sales_organization_id": "5b502152-4427-4595-90e5-41910ed3afa5",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fe7dd4e1-09a8-4666-af39-b82bde70e2bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0924897b-04dd-4392-b322-495ef99065ec",
"db_currency_id": "beca0cab-e825-4dea-946b-74e036244957",
"db_language_id": "421aba26-6e03-486f-9483-8ee98343cbb0",
"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-08-21T21:37:47.8001096+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-08-21T21:37:47.8001096+00:00"
},
"project_status_id": "0efac34c-408a-4951-adf6-0819b55058c9",
"project_status_code": "sample string 10",
"project_status": {
"id": "a43100fc-5d71-44b4-a50e-06776830e76b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bd755065-2da2-46dc-90d1-6f009b1d6a06",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fe7dd4e1-09a8-4666-af39-b82bde70e2bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0924897b-04dd-4392-b322-495ef99065ec",
"db_currency_id": "beca0cab-e825-4dea-946b-74e036244957",
"db_language_id": "421aba26-6e03-486f-9483-8ee98343cbb0",
"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-08-21T21:37:47.8001096+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-21T21:37:47.8001096+00:00"
},
"company_id": "7df93aa7-3a0e-4d75-83e4-b4a6cd77dad1",
"company_code": "sample string 12",
"db_address_id": "d2f41d3a-6fec-4ee8-bdb5-93affe13e187",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f292d758-f6a4-4dc5-8c32-78f140c4fb96",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a46921a7-054f-4fee-a18c-9094e27715d1",
"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-08-21T21:37:47.8001096+00:00",
"date_create": "2026-08-21T21:37:47.8001096+00:00",
"date_update": "2026-08-21T21:37:47.8001096+00:00",
"updated_by_user_id": "6a3cbb92-a425-406b-a54f-a73c925523b8",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-21T21:37:47.8001096+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-08-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-21T21:37:47.8001096+00:00",
"date_last_job": "2026-08-21T21:37:47.8001096+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-21T21:37:47.8001096+00:00",
"modified_dateutc": "2026-08-21T21:37:47.8001096+00:00",
"is_mobile_installation": true
},
"job_type_id": "e86ea935-5c7e-4749-ac41-ea00bef5a542",
"job_type_code": "sample string 7",
"job_type": {
"id": "44925a74-32d1-47dd-b0a6-eb174d531a8a",
"name": "sample string 2",
"sales_organization_id": "f9957237-ac9c-4c0a-8752-ae0b725d30c9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-21T21:37:47.8001096+00:00",
"code": "sample string 7"
},
"job_priority_id": "45591602-545d-43d6-aa86-b961a1125ff0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3a058f92-545d-498e-9335-4aeb8339c18f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e637012f-97ed-4844-9d31-19dcc24f02eb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fe7dd4e1-09a8-4666-af39-b82bde70e2bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0924897b-04dd-4392-b322-495ef99065ec",
"db_currency_id": "beca0cab-e825-4dea-946b-74e036244957",
"db_language_id": "421aba26-6e03-486f-9483-8ee98343cbb0",
"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-08-21T21:37:47.8001096+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-21T21:37:47.8001096+00:00"
},
"job_status_id": "2d7aa65a-f5da-4e2d-8ac9-62edb2eb811b",
"job_status_code": "sample string 11",
"db_address_id": "36ac0a24-5ea7-4276-bdfe-9620c10dd6e6",
"contact_id": "2b5a803a-1358-4faa-aeea-d728f0ce2aa7",
"requested_by_company_id": "5846c4e9-8a8a-4b17-9c97-161338be98f6",
"requested_by_contact_id": "e4973567-4062-4541-8cbc-ae3327c158a6",
"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-08-21T21:37:47.8001096+00:00",
"due_date": "2026-08-21T21:37:47.8001096+00:00",
"date_create": "2026-08-21T21:37:47.8001096+00:00",
"date_update": "2026-08-21T21:37:47.8001096+00:00",
"date_closed": "2026-08-21T21:37:47.8001096+00:00",
"suggested_user_id": "c8cecf23-c803-4a54-860e-f0422f4838d3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "807afe05-7cd8-43a2-a070-71a8415dca8c",
"db_language_id": "7136fbd1-4c9b-4bc3-abaf-c140f56d37ad",
"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-08-21T21:37:47.8001096+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "846e785c-66bd-4d6c-b634-55ec99cbc9f9",
"sales_organization": {
"id": "fe7dd4e1-09a8-4666-af39-b82bde70e2bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0924897b-04dd-4392-b322-495ef99065ec",
"db_currency_id": "beca0cab-e825-4dea-946b-74e036244957",
"db_language_id": "421aba26-6e03-486f-9483-8ee98343cbb0",
"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-08-21T21:37:47.8001096+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "631021e0-bcff-4c6d-8025-ef7fd420790b",
"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": "789f17ce-b021-4d8e-8dbb-9483085d1f49",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-21T21:37:47.8001096+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "87fdb90a-477b-440a-aafa-b080fe9dbc6b"
},
"suggested_date_start": "2026-08-21T21:37:47.8001096+00:00",
"skill_id": "6cbc18c2-9a56-4422-a85c-7d5fdbd8e369",
"skill_code": "sample string 32",
"skill": {
"id": "3e943839-4eab-45b0-b5b3-cdc78b85e8fb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d3c4cd79-216c-4dfc-bfc6-ce34023b2997",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fe7dd4e1-09a8-4666-af39-b82bde70e2bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0924897b-04dd-4392-b322-495ef99065ec",
"db_currency_id": "beca0cab-e825-4dea-946b-74e036244957",
"db_language_id": "421aba26-6e03-486f-9483-8ee98343cbb0",
"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-08-21T21:37:47.8001096+00:00"
},
"modified_dateutc": "2026-08-21T21:37:47.8001096+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3746f9cb-fcc3-4d4a-acec-fa75665e538d",
"date_reported_by_company": "2026-08-21T21:37:47.8001096+00:00",
"id2": 36,
"company_id": "51ca3228-2dc1-4ff0-b39f-30cc877a1d77",
"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": "ce774a47-7eda-49e2-833a-7156cf835d3b",
"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-08-21T21:37:47.8001096+00:00"
},
"work_instruction_details_id": "cd2683c6-240a-4eac-828b-243257b889a3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4c8b3146-265e-49d3-938f-d45abf266b40",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3547fb6e-1e86-489d-a0dd-daa0f8142746",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-21T21:37:47.8001096+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": "020cb1b0-b8ad-433b-bd41-d003d1143631",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-21T21:37:47.8001096+00:00"
}