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": "ca042340-1360-4052-99ad-fb4997f7033d",
"jobs_id": "9bc6a288-c867-4571-b3ec-7b3ddc08efc2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6c217950-4604-4944-83d1-2075e694c56c",
"_parent_id": "9b18c3d4-b49b-43af-b19d-a7914bf4b2ec",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "042d5dfc-2a05-41ce-a902-4ae7e580d5d0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3b3dcf0e-de4f-44dc-9041-1bb3db2a15a9",
"_parent_id": "1cc7e6b0-ba86-4fb8-ba6d-1ccde1465f56",
"root_parent_id": "8ec81312-7e6a-4e7e-9952-d3ac3adb7bbb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "77fb01c1-da2e-44a9-9c6c-9fb3bc852e53",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "05cebb84-7651-4a0d-a3a9-f88d0cd83931",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b65e9ecb-c9fe-4ffa-a05f-d0afb7156c2b",
"_parent_code": "sample string 6",
"sales_organization_id": "2c5e44ad-cf0c-4e68-991c-c35306464685",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1a53e338-8818-405e-a8b8-a9e9eef94609",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b59a6961-8927-4eff-bd6b-223dcd4f2352",
"db_currency_id": "87ed2973-946e-4851-ba0a-663111f70d22",
"db_language_id": "f6115334-2a14-4b82-ac80-0ee4fd06bfbb",
"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-04-08T10:14:20.4040938+00:00"
},
"modified_dateutc": "2026-04-08T10:14:20.4040938+00:00"
},
"equipment_model_id": "ad18aa4d-12dc-40df-ba01-38dd651a67b6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a8ce18d4-caa4-42b3-95ab-e5ff3aefd73c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9be3f47a-b327-4ca6-886a-210a69cd77f2",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b3c0897f-6330-48e5-a255-c614205a3136",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "734e1283-8ae5-422d-bdc9-b82b3b4da12a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1a53e338-8818-405e-a8b8-a9e9eef94609",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b59a6961-8927-4eff-bd6b-223dcd4f2352",
"db_currency_id": "87ed2973-946e-4851-ba0a-663111f70d22",
"db_language_id": "f6115334-2a14-4b82-ac80-0ee4fd06bfbb",
"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-04-08T10:14:20.4040938+00:00"
},
"modified_dateutc": "2026-04-08T10:14:20.4040938+00:00"
},
"equipment_family_id": "0633eb08-c7ad-4382-a5b9-3a46df0b153e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "05cebb84-7651-4a0d-a3a9-f88d0cd83931",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b65e9ecb-c9fe-4ffa-a05f-d0afb7156c2b",
"_parent_code": "sample string 6",
"sales_organization_id": "2c5e44ad-cf0c-4e68-991c-c35306464685",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1a53e338-8818-405e-a8b8-a9e9eef94609",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b59a6961-8927-4eff-bd6b-223dcd4f2352",
"db_currency_id": "87ed2973-946e-4851-ba0a-663111f70d22",
"db_language_id": "f6115334-2a14-4b82-ac80-0ee4fd06bfbb",
"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-04-08T10:14:20.4040938+00:00"
},
"modified_dateutc": "2026-04-08T10:14:20.4040938+00:00"
},
"date_in_production_since": "2026-04-08T10:14:20.4040938+00:00",
"date_out_of_production_since": "2026-04-08T10:14:20.4040938+00:00",
"date_end_support": "2026-04-08T10:14:20.4040938+00:00",
"sales_organization_id": "f3bc3f3e-bc98-4468-8b63-0bc72570a5d9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1a53e338-8818-405e-a8b8-a9e9eef94609",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b59a6961-8927-4eff-bd6b-223dcd4f2352",
"db_currency_id": "87ed2973-946e-4851-ba0a-663111f70d22",
"db_language_id": "f6115334-2a14-4b82-ac80-0ee4fd06bfbb",
"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-04-08T10:14:20.4040938+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-04-08T10:14:20.4040938+00:00"
},
"project_status_id": "e7697c7a-f904-438d-b720-999e92df6523",
"project_status_code": "sample string 10",
"project_status": {
"id": "14fac2d7-3b18-486d-985c-08f99fa2ddd1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "965d27cf-3c60-475a-91eb-3d1382f80a02",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1a53e338-8818-405e-a8b8-a9e9eef94609",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b59a6961-8927-4eff-bd6b-223dcd4f2352",
"db_currency_id": "87ed2973-946e-4851-ba0a-663111f70d22",
"db_language_id": "f6115334-2a14-4b82-ac80-0ee4fd06bfbb",
"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-04-08T10:14:20.4040938+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-08T10:14:20.4040938+00:00"
},
"company_id": "64f46953-6b97-4b8b-b07b-b44eb61f5bbf",
"company_code": "sample string 12",
"db_address_id": "ebf26101-f751-463f-a53c-4e2448ab625f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8d9a4d0e-d160-4d63-8c73-ac16458f564e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4d1e0389-19f1-4258-ad19-cae5f19d570c",
"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-04-08T10:14:20.4040938+00:00",
"date_create": "2026-04-08T10:14:20.4040938+00:00",
"date_update": "2026-04-08T10:14:20.4040938+00:00",
"updated_by_user_id": "7ec3718e-323e-4b07-afd5-dc91274603de",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-08T10:14:20.4040938+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-04-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-08T10:14:20.4040938+00:00",
"date_last_job": "2026-04-08T10:14:20.4040938+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-08T10:14:20.4040938+00:00",
"modified_dateutc": "2026-04-08T10:14:20.4040938+00:00",
"is_mobile_installation": true
},
"job_type_id": "cc59c083-ed2d-4073-afaf-9840b19097b0",
"job_type_code": "sample string 7",
"job_type": {
"id": "63b30d26-8ba9-465e-b951-a111b0505411",
"name": "sample string 2",
"sales_organization_id": "1a3014e0-87ee-448d-8e2c-c5d046ec26d8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-08T10:14:20.4040938+00:00",
"code": "sample string 7"
},
"job_priority_id": "87cf2586-b88e-4302-bfa7-6fe837c36cfd",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "08f76ba2-dbb6-4aef-9742-a1a26d2eec60",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4c7dc1bf-6514-4b49-b6a8-74ea2d6a75c7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1a53e338-8818-405e-a8b8-a9e9eef94609",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b59a6961-8927-4eff-bd6b-223dcd4f2352",
"db_currency_id": "87ed2973-946e-4851-ba0a-663111f70d22",
"db_language_id": "f6115334-2a14-4b82-ac80-0ee4fd06bfbb",
"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-04-08T10:14:20.4040938+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-08T10:14:20.4040938+00:00"
},
"job_status_id": "004368ad-e61b-4b05-8398-04306136f7a5",
"job_status_code": "sample string 11",
"db_address_id": "77ce6ae7-b299-4f85-b92e-d96392264458",
"contact_id": "313d0e05-52fe-4483-b816-707d6398a3fa",
"requested_by_company_id": "dff8bcf5-f97e-4f3b-b07a-b8e3bf5bb721",
"requested_by_contact_id": "6f9fc937-93e5-442b-a76f-daada1fc66e3",
"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-04-08T10:14:20.4040938+00:00",
"due_date": "2026-04-08T10:14:20.4040938+00:00",
"date_create": "2026-04-08T10:14:20.4040938+00:00",
"date_update": "2026-04-08T10:14:20.4040938+00:00",
"date_closed": "2026-04-08T10:14:20.4040938+00:00",
"suggested_user_id": "1b253790-e6cc-44f7-b2bf-fa65c9715ed3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3ebd2a33-9ca0-4b19-b9b9-5449596ffc39",
"db_language_id": "d80aaa10-fa7e-47be-8474-6917210bb117",
"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-04-08T10:14:20.4040938+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1962d7ad-c6b1-4c7a-9c2f-4139837ab538",
"sales_organization": {
"id": "1a53e338-8818-405e-a8b8-a9e9eef94609",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b59a6961-8927-4eff-bd6b-223dcd4f2352",
"db_currency_id": "87ed2973-946e-4851-ba0a-663111f70d22",
"db_language_id": "f6115334-2a14-4b82-ac80-0ee4fd06bfbb",
"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-04-08T10:14:20.4040938+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8378102b-4d91-480c-b65f-aea56a85ec81",
"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": "c9e8b08e-d2ef-446d-8873-353844d04ecb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-08T10:14:20.4040938+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "780bf805-0499-4a1d-b19b-d9820cb2b9f3"
},
"suggested_date_start": "2026-04-08T10:14:20.4040938+00:00",
"skill_id": "75fc01b0-0e5b-40d2-8079-e40e9e5ff0e6",
"skill_code": "sample string 32",
"skill": {
"id": "54581fb1-3877-4661-b6f6-65f3771be08a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cc6395fb-172f-4b3e-978f-28006d478b81",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1a53e338-8818-405e-a8b8-a9e9eef94609",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b59a6961-8927-4eff-bd6b-223dcd4f2352",
"db_currency_id": "87ed2973-946e-4851-ba0a-663111f70d22",
"db_language_id": "f6115334-2a14-4b82-ac80-0ee4fd06bfbb",
"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-04-08T10:14:20.4040938+00:00"
},
"modified_dateutc": "2026-04-08T10:14:20.4040938+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "95200639-4fd6-4ff0-bafd-95cc24377040",
"date_reported_by_company": "2026-04-08T10:14:20.4040938+00:00",
"id2": 36,
"company_id": "bdfd4b6d-6715-417d-a686-1645e20e4c70",
"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": "5701ac19-9162-40a8-a706-88a74a6b5404",
"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-04-08T10:14:20.4040938+00:00"
},
"work_instruction_details_id": "1d71980f-ed2f-472a-a0b5-8fbdc86cb864",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f207b4e1-9647-4a2d-a14a-068af3c1c55c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "55fe3138-d63f-4ccf-adc2-137781683dac",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-08T10:14:20.4040938+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": "b902a5d6-001d-49fe-969c-5690c71747cb",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-08T10:14:20.4040938+00:00"
}