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": "b011f102-2d01-48ee-be3c-114b99709717",
"jobs_id": "c4c3e5c6-ba23-43d5-8861-0f79d85e4d3e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1885a045-0e7a-4abe-8396-8139b6920009",
"_parent_id": "2424101b-5220-4d5e-9fb9-4903510913ab",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1a0c87af-b288-4981-9a64-675405f92b08",
"project_reference_back_office": "sample string 5",
"project": {
"id": "13fad40c-1098-44e5-8564-2c955e777d49",
"_parent_id": "b9a4f6cc-6903-40d6-a69e-c1d6b862072c",
"root_parent_id": "78b09cb3-e307-4d0b-9c6f-47b4c30fcdc6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "986361e8-5ece-4578-86a2-b11ecf77fb82",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5da20ac1-f302-471c-85b2-810174819a9b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5c13cf57-25cd-45bb-a5e7-fa77a97f8fab",
"_parent_code": "sample string 6",
"sales_organization_id": "c46c7f49-dc93-49a7-b794-cd3ced2d024b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "41be561b-3d90-4947-839b-738ee9a10203",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0523dfd3-37b6-4e85-ae04-238f73ee1c08",
"db_currency_id": "4f2729af-1fe7-43ee-957d-1a32be75ccc8",
"db_language_id": "8bd88c84-42a6-4b45-965c-36baf7d4e7c9",
"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-29T10:20:26.8469269+00:00"
},
"modified_dateutc": "2026-01-29T10:20:26.8469269+00:00"
},
"equipment_model_id": "3ca5475e-017a-43a6-aafc-0ed6092e409a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "671d84ed-9224-47eb-b0a3-937eab7d5284",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d3d55118-bc0d-4c98-af5a-ae633e936af8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "cd768824-e80e-4779-ae90-8715f3dae252",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f959e1f1-8e0a-4350-8ed6-2dee6f59a9ab",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "41be561b-3d90-4947-839b-738ee9a10203",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0523dfd3-37b6-4e85-ae04-238f73ee1c08",
"db_currency_id": "4f2729af-1fe7-43ee-957d-1a32be75ccc8",
"db_language_id": "8bd88c84-42a6-4b45-965c-36baf7d4e7c9",
"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-29T10:20:26.8469269+00:00"
},
"modified_dateutc": "2026-01-29T10:20:26.8469269+00:00"
},
"equipment_family_id": "8f7a13ef-22ca-4205-8242-36439c1766b2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5da20ac1-f302-471c-85b2-810174819a9b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5c13cf57-25cd-45bb-a5e7-fa77a97f8fab",
"_parent_code": "sample string 6",
"sales_organization_id": "c46c7f49-dc93-49a7-b794-cd3ced2d024b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "41be561b-3d90-4947-839b-738ee9a10203",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0523dfd3-37b6-4e85-ae04-238f73ee1c08",
"db_currency_id": "4f2729af-1fe7-43ee-957d-1a32be75ccc8",
"db_language_id": "8bd88c84-42a6-4b45-965c-36baf7d4e7c9",
"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-29T10:20:26.8469269+00:00"
},
"modified_dateutc": "2026-01-29T10:20:26.8469269+00:00"
},
"date_in_production_since": "2026-01-29T10:20:26.8469269+00:00",
"date_out_of_production_since": "2026-01-29T10:20:26.8469269+00:00",
"date_end_support": "2026-01-29T10:20:26.8469269+00:00",
"sales_organization_id": "1cb082cf-2b43-4728-b6a6-4654025928ea",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "41be561b-3d90-4947-839b-738ee9a10203",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0523dfd3-37b6-4e85-ae04-238f73ee1c08",
"db_currency_id": "4f2729af-1fe7-43ee-957d-1a32be75ccc8",
"db_language_id": "8bd88c84-42a6-4b45-965c-36baf7d4e7c9",
"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-29T10:20:26.8469269+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-29T10:20:26.8469269+00:00"
},
"project_status_id": "d8c91f18-943e-4249-bab4-cffc335f73b9",
"project_status_code": "sample string 10",
"project_status": {
"id": "ee3f8d81-7eb5-4ef4-b3d3-6a75e0dc58c3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b022dd1e-7c1f-4a25-b85d-78d051171a74",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "41be561b-3d90-4947-839b-738ee9a10203",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0523dfd3-37b6-4e85-ae04-238f73ee1c08",
"db_currency_id": "4f2729af-1fe7-43ee-957d-1a32be75ccc8",
"db_language_id": "8bd88c84-42a6-4b45-965c-36baf7d4e7c9",
"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-29T10:20:26.8469269+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-29T10:20:26.8469269+00:00"
},
"company_id": "79c63e68-224b-4468-a0ab-ee2afd237d7e",
"company_code": "sample string 12",
"db_address_id": "de5cc73b-63f7-4d2a-bb8f-454aa76aab3b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a63e9cb9-9e8f-487d-92b3-dcb724b2a3d4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "07eca7b0-1ad6-444a-9339-6c0b4e07c3c2",
"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-29T10:20:26.8469269+00:00",
"date_create": "2026-01-29T10:20:26.8469269+00:00",
"date_update": "2026-01-29T10:20:26.8469269+00:00",
"updated_by_user_id": "99861fe6-8df7-457b-9227-4a55055df412",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-29T10:20:26.8469269+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-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-29T10:20:26.8469269+00:00",
"date_last_job": "2026-01-29T10:20:26.8469269+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-29T10:20:26.8469269+00:00",
"modified_dateutc": "2026-01-29T10:20:26.8469269+00:00",
"is_mobile_installation": true
},
"job_type_id": "f9b36080-988b-44de-8a42-e6874e65e06c",
"job_type_code": "sample string 7",
"job_type": {
"id": "f6a558d8-a221-4ab1-b815-0d5f1a54ec7f",
"name": "sample string 2",
"sales_organization_id": "448d2281-b42b-4b22-bb3a-50b23c7636b4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-29T10:20:26.8469269+00:00",
"code": "sample string 7"
},
"job_priority_id": "b39c6ee9-3f37-44c6-934a-f5d460b37aad",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f484fc4e-2512-4582-bb0f-d9a1c23c012b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f52bb663-343c-4d23-9064-9213e788961f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "41be561b-3d90-4947-839b-738ee9a10203",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0523dfd3-37b6-4e85-ae04-238f73ee1c08",
"db_currency_id": "4f2729af-1fe7-43ee-957d-1a32be75ccc8",
"db_language_id": "8bd88c84-42a6-4b45-965c-36baf7d4e7c9",
"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-29T10:20:26.8469269+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-29T10:20:26.8469269+00:00"
},
"job_status_id": "7335f4f0-887d-4fa9-b175-53b62a2894f3",
"job_status_code": "sample string 11",
"db_address_id": "1dc8574e-d587-4e40-b2ea-50c5a2bb00d1",
"contact_id": "14e4acd3-d9ee-45f6-8f01-5e22f27c813d",
"requested_by_company_id": "722faef4-f3cc-43c4-ac49-ea415ee7741b",
"requested_by_contact_id": "959f9666-c091-4b42-baad-03f4c8781513",
"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-29T10:20:26.8469269+00:00",
"due_date": "2026-01-29T10:20:26.8469269+00:00",
"date_create": "2026-01-29T10:20:26.8469269+00:00",
"date_update": "2026-01-29T10:20:26.8469269+00:00",
"date_closed": "2026-01-29T10:20:26.8469269+00:00",
"suggested_user_id": "da76f8db-a66f-47c1-b22a-bea0c5b96a8c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5aacc10c-c4a2-43a9-bfff-f0250d0f0392",
"db_language_id": "a5c8a72e-fcb1-4244-bbd5-77c6174ad350",
"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-29T10:20:26.8469269+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4462277b-7e73-4e85-bb92-3633d92bfd2c",
"sales_organization": {
"id": "41be561b-3d90-4947-839b-738ee9a10203",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0523dfd3-37b6-4e85-ae04-238f73ee1c08",
"db_currency_id": "4f2729af-1fe7-43ee-957d-1a32be75ccc8",
"db_language_id": "8bd88c84-42a6-4b45-965c-36baf7d4e7c9",
"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-29T10:20:26.8469269+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "cbe55f53-86e1-46e2-9d11-10f49d5f7816",
"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": "8375ce70-3354-4709-bc39-1d786c764106",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-29T10:20:26.8469269+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "51fa375a-7412-4e61-a488-6f31267b1cd3"
},
"suggested_date_start": "2026-01-29T10:20:26.8469269+00:00",
"skill_id": "cc855c5c-e3b3-4db2-9394-2c5b21375587",
"skill_code": "sample string 32",
"skill": {
"id": "c6186821-dd7c-4a82-9175-dd1cb220c7ac",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3efae6d8-bbf6-4161-a8a3-41884394c6dd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "41be561b-3d90-4947-839b-738ee9a10203",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0523dfd3-37b6-4e85-ae04-238f73ee1c08",
"db_currency_id": "4f2729af-1fe7-43ee-957d-1a32be75ccc8",
"db_language_id": "8bd88c84-42a6-4b45-965c-36baf7d4e7c9",
"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-29T10:20:26.8469269+00:00"
},
"modified_dateutc": "2026-01-29T10:20:26.8469269+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "267705a7-f97e-4eef-9d5d-bd73ad2a7119",
"date_reported_by_company": "2026-01-29T10:20:26.8469269+00:00",
"id2": 36,
"company_id": "d533c45c-f6a5-4c69-9104-19bd1c993977",
"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": "5b48e497-28b2-4e76-af4b-8ebd876db0c4",
"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-29T10:20:26.8469269+00:00"
},
"work_instruction_details_id": "a2838879-f95e-42ed-80f8-8ea585e5fcd6",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e7b30505-403e-4ed4-bcfc-4ef0f906276d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "09711626-5b49-4c4b-b066-0480317c0812",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-29T10:20:26.8469269+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": "b0b23587-d999-4717-9a53-62d4193322de",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-29T10:20:26.8469269+00:00"
}