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": "9afde9c1-600e-4948-9775-ceece52357f1",
"jobs_id": "6a56d78f-80a3-4b68-bfe3-89ff2a89b875",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "eddc6eb1-fffb-4c2b-883b-7d1eed178822",
"_parent_id": "207c9352-fd80-49fc-a361-556e7a8a2c8e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "553811ba-3368-4681-961b-988a49bf6fee",
"project_reference_back_office": "sample string 5",
"project": {
"id": "74ba8f0a-898d-4d4e-83fb-ae78eed24160",
"_parent_id": "a5fbf012-9713-4b80-b90c-ad80dde7e6f7",
"root_parent_id": "604620d9-fcd9-47b1-810b-2fe69dcb3bec",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "d0e5640c-eb7c-4d2b-baaa-1b8c599e6639",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "80b630d4-91b5-42a9-b834-d45395dc7efe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fc61ec3e-5315-4dca-b6de-7558142eacca",
"_parent_code": "sample string 6",
"sales_organization_id": "24ba16fc-a3df-41b5-afef-5a537ce61063",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5002bd6e-e3ce-4111-b564-1655941dddf1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a57937ca-f75b-4f40-9136-2d40c91cb699",
"db_currency_id": "610fe151-f5d7-4ca9-8a24-76152525d36e",
"db_language_id": "6bea6e2b-a690-4b68-88b9-f2c97f4c8db7",
"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-09-11T22:24:15.2391267+00:00"
},
"modified_dateutc": "2026-09-11T22:24:15.2391267+00:00"
},
"equipment_model_id": "05e3bbd8-f1f4-422c-babb-df03c514b0a6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9b70b7bd-576d-4317-b097-f7648702e6c9",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "24b6d1e6-85b8-46c6-8739-0d6576721c52",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c7b18ec7-01a9-49d8-9d45-1d86643d4f0f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fd0f5152-cce3-47b2-9d2b-7801e71cbf05",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5002bd6e-e3ce-4111-b564-1655941dddf1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a57937ca-f75b-4f40-9136-2d40c91cb699",
"db_currency_id": "610fe151-f5d7-4ca9-8a24-76152525d36e",
"db_language_id": "6bea6e2b-a690-4b68-88b9-f2c97f4c8db7",
"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-09-11T22:24:15.2391267+00:00"
},
"modified_dateutc": "2026-09-11T22:24:15.2391267+00:00"
},
"equipment_family_id": "77de8175-92f3-4c4f-a336-4a1923acb5cd",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "80b630d4-91b5-42a9-b834-d45395dc7efe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fc61ec3e-5315-4dca-b6de-7558142eacca",
"_parent_code": "sample string 6",
"sales_organization_id": "24ba16fc-a3df-41b5-afef-5a537ce61063",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5002bd6e-e3ce-4111-b564-1655941dddf1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a57937ca-f75b-4f40-9136-2d40c91cb699",
"db_currency_id": "610fe151-f5d7-4ca9-8a24-76152525d36e",
"db_language_id": "6bea6e2b-a690-4b68-88b9-f2c97f4c8db7",
"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-09-11T22:24:15.2391267+00:00"
},
"modified_dateutc": "2026-09-11T22:24:15.2391267+00:00"
},
"date_in_production_since": "2026-09-11T22:24:15.2391267+00:00",
"date_out_of_production_since": "2026-09-11T22:24:15.2391267+00:00",
"date_end_support": "2026-09-11T22:24:15.2391267+00:00",
"sales_organization_id": "ff399fad-f07e-46d0-9d3a-c39b094d0077",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5002bd6e-e3ce-4111-b564-1655941dddf1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a57937ca-f75b-4f40-9136-2d40c91cb699",
"db_currency_id": "610fe151-f5d7-4ca9-8a24-76152525d36e",
"db_language_id": "6bea6e2b-a690-4b68-88b9-f2c97f4c8db7",
"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-09-11T22:24:15.2391267+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-09-11T22:24:15.2391267+00:00"
},
"project_status_id": "eba2b349-5fce-4763-8075-5e895542be26",
"project_status_code": "sample string 10",
"project_status": {
"id": "06a93d3c-da2b-46f3-ac46-4b0fb717510a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7e49228e-bf71-4dab-ba29-4e884b6e1734",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5002bd6e-e3ce-4111-b564-1655941dddf1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a57937ca-f75b-4f40-9136-2d40c91cb699",
"db_currency_id": "610fe151-f5d7-4ca9-8a24-76152525d36e",
"db_language_id": "6bea6e2b-a690-4b68-88b9-f2c97f4c8db7",
"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-09-11T22:24:15.2391267+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-11T22:24:15.2391267+00:00"
},
"company_id": "91ac6f38-553c-4456-be54-e85846ffb52a",
"company_code": "sample string 12",
"db_address_id": "69f37027-0c73-4403-879a-a4883117b8ec",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8e9b3cb2-8b1b-4d83-91c4-217f2728f96a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f9e249af-25e6-44ea-8f97-a1360d397c6b",
"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-09-11T22:24:15.2391267+00:00",
"date_create": "2026-09-11T22:24:15.2391267+00:00",
"date_update": "2026-09-11T22:24:15.2391267+00:00",
"updated_by_user_id": "566c10b3-66d3-4340-af38-caeff5f48a56",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-11T22:24:15.2391267+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-09-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-11T22:24:15.2391267+00:00",
"date_last_job": "2026-09-11T22:24:15.2391267+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-11T22:24:15.2391267+00:00",
"modified_dateutc": "2026-09-11T22:24:15.2391267+00:00",
"is_mobile_installation": true
},
"job_type_id": "98303402-d7fd-4373-a8ad-371540aa746c",
"job_type_code": "sample string 7",
"job_type": {
"id": "d4109873-0a63-4677-aba3-0477615bf807",
"name": "sample string 2",
"sales_organization_id": "083bf4af-aa01-4e9c-9ab8-9e83a4796747",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-11T22:24:15.2391267+00:00",
"code": "sample string 7"
},
"job_priority_id": "1e3337f0-2a14-47d1-b990-3de513e2388b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4e5d6bcb-2ee5-4d07-af5e-ed0b77936cb2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e0445bc9-d793-4dc4-b808-5bbce11c1b23",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5002bd6e-e3ce-4111-b564-1655941dddf1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a57937ca-f75b-4f40-9136-2d40c91cb699",
"db_currency_id": "610fe151-f5d7-4ca9-8a24-76152525d36e",
"db_language_id": "6bea6e2b-a690-4b68-88b9-f2c97f4c8db7",
"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-09-11T22:24:15.2391267+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-11T22:24:15.2391267+00:00"
},
"job_status_id": "13ee2195-c2d0-492a-bf3b-c060bcf5b4d4",
"job_status_code": "sample string 11",
"db_address_id": "d9a8cbae-ba3e-424f-99ad-42a76c8af917",
"contact_id": "77f9f8d9-6f91-408a-9fc1-51fa82e81daf",
"requested_by_company_id": "fba9f00f-86c8-4728-9e93-7aa63a2f20dc",
"requested_by_contact_id": "e4716734-de85-40cb-8755-1e7153a1f63e",
"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-09-11T22:24:15.2391267+00:00",
"due_date": "2026-09-11T22:24:15.2391267+00:00",
"date_create": "2026-09-11T22:24:15.2391267+00:00",
"date_update": "2026-09-11T22:24:15.2391267+00:00",
"date_closed": "2026-09-11T22:24:15.2391267+00:00",
"suggested_user_id": "d59afaf0-de41-4715-89dd-1c34bc27ff5b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b387aed9-5547-4148-bfa3-fcc60d257445",
"db_language_id": "55e1a326-b6f7-44b7-8073-14796c7e7c53",
"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-09-11T22:24:15.2547529+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "14047d7d-d0fa-428a-bafe-70a291017502",
"sales_organization": {
"id": "5002bd6e-e3ce-4111-b564-1655941dddf1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a57937ca-f75b-4f40-9136-2d40c91cb699",
"db_currency_id": "610fe151-f5d7-4ca9-8a24-76152525d36e",
"db_language_id": "6bea6e2b-a690-4b68-88b9-f2c97f4c8db7",
"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-09-11T22:24:15.2391267+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7fe74f92-0c7f-48bc-8a90-f75a811afa28",
"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": "d00ea0c6-efe1-4eab-bbef-86860b9b7a5d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-11T22:24:15.2547529+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5ccec73d-9409-4f1f-8326-7c6fe8a48fa2"
},
"suggested_date_start": "2026-09-11T22:24:15.2547529+00:00",
"skill_id": "4b65302f-4ade-4ece-9228-bd27da274e86",
"skill_code": "sample string 32",
"skill": {
"id": "8105619d-ef61-424f-838c-1c833df38521",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "37275b7c-771d-44fe-91b6-be94c715bc03",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5002bd6e-e3ce-4111-b564-1655941dddf1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a57937ca-f75b-4f40-9136-2d40c91cb699",
"db_currency_id": "610fe151-f5d7-4ca9-8a24-76152525d36e",
"db_language_id": "6bea6e2b-a690-4b68-88b9-f2c97f4c8db7",
"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-09-11T22:24:15.2391267+00:00"
},
"modified_dateutc": "2026-09-11T22:24:15.2547529+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e0de1c30-274f-42c0-8728-9c3fa75d2a48",
"date_reported_by_company": "2026-09-11T22:24:15.2547529+00:00",
"id2": 36,
"company_id": "3d12a189-9484-49e4-8fdb-73408967b094",
"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": "1ee34b69-6fcd-4e04-9744-0fdbe6cd4529",
"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-09-11T22:24:15.2547529+00:00"
},
"work_instruction_details_id": "3d5fb10a-7a7d-4e55-b075-3f6547afcae6",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f9df9c99-34bd-4599-bfb3-900858f47b17",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d1e71580-4e7f-4685-846f-d8bce0d3cbed",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-11T22:24:15.2547529+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": "bb13ffa6-1edf-4c8f-ab35-8e27aeb6d18c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-11T22:24:15.2547529+00:00"
}