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": "2b55276f-8311-4a50-8499-9b0d46d8bfa9",
"jobs_id": "abf6a1b0-e062-4069-8509-df49a29ade9e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f7f15942-95c3-41d1-a6f5-a5c1a308d066",
"_parent_id": "70942930-5d73-4788-b3f4-caf983c4f128",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "17a69e44-fe09-4a0c-a68c-7592fba657f1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "dbae7333-80c0-40fc-b90a-cb104be8e4ef",
"_parent_id": "8dddbfb7-e098-4eac-8102-fae47e2e57e2",
"root_parent_id": "259c9c0a-a2f9-4954-9373-2aceecb499ac",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f3c32f0a-9436-4988-aeb0-5ba2d04494c1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5b7f1e6d-c12c-4598-92ff-f8dbcdae4399",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a51fdfda-39ba-410a-a014-971cad9527cf",
"_parent_code": "sample string 6",
"sales_organization_id": "484cf9dd-0444-4ed0-a551-432ca4772952",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fe42e868-e0e6-46b7-b1b7-010c59c6b334",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5691c831-fc9d-4943-a9d2-f2f05368a17d",
"db_currency_id": "fd31735d-ed51-4745-b381-e64d0772fc9f",
"db_language_id": "28604f1c-77ac-450d-9a70-9bb3359b9922",
"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-30T17:20:40.4111315+00:00"
},
"modified_dateutc": "2026-08-30T17:20:40.4111315+00:00"
},
"equipment_model_id": "476f3e64-d124-49e8-bb6a-a81f8a0da343",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "19f92e69-deee-4fbb-804d-6c6a0e8137b0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9a3ddbb0-38c3-4865-b4db-8af215c6f427",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0419214a-ce08-4828-a0ca-9f592d34051f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2b69612e-50cf-4e3e-8202-62cbc45eba9e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fe42e868-e0e6-46b7-b1b7-010c59c6b334",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5691c831-fc9d-4943-a9d2-f2f05368a17d",
"db_currency_id": "fd31735d-ed51-4745-b381-e64d0772fc9f",
"db_language_id": "28604f1c-77ac-450d-9a70-9bb3359b9922",
"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-30T17:20:40.4111315+00:00"
},
"modified_dateutc": "2026-08-30T17:20:40.4111315+00:00"
},
"equipment_family_id": "2df1d83e-055d-4057-9d09-0affa3761dcc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5b7f1e6d-c12c-4598-92ff-f8dbcdae4399",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a51fdfda-39ba-410a-a014-971cad9527cf",
"_parent_code": "sample string 6",
"sales_organization_id": "484cf9dd-0444-4ed0-a551-432ca4772952",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fe42e868-e0e6-46b7-b1b7-010c59c6b334",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5691c831-fc9d-4943-a9d2-f2f05368a17d",
"db_currency_id": "fd31735d-ed51-4745-b381-e64d0772fc9f",
"db_language_id": "28604f1c-77ac-450d-9a70-9bb3359b9922",
"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-30T17:20:40.4111315+00:00"
},
"modified_dateutc": "2026-08-30T17:20:40.4111315+00:00"
},
"date_in_production_since": "2026-08-30T17:20:40.4111315+00:00",
"date_out_of_production_since": "2026-08-30T17:20:40.4111315+00:00",
"date_end_support": "2026-08-30T17:20:40.4111315+00:00",
"sales_organization_id": "8e6849f7-73de-4555-9ebc-a3bfc17528e2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fe42e868-e0e6-46b7-b1b7-010c59c6b334",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5691c831-fc9d-4943-a9d2-f2f05368a17d",
"db_currency_id": "fd31735d-ed51-4745-b381-e64d0772fc9f",
"db_language_id": "28604f1c-77ac-450d-9a70-9bb3359b9922",
"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-30T17:20:40.4111315+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-30T17:20:40.4111315+00:00"
},
"project_status_id": "faf95b3e-e86c-4838-8dbc-5dd792f86ba0",
"project_status_code": "sample string 10",
"project_status": {
"id": "4124eda1-cbf4-4e28-9e5c-7c5bcd12e237",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "612e4e83-84ef-4ae0-b54b-6b7fac0366f9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fe42e868-e0e6-46b7-b1b7-010c59c6b334",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5691c831-fc9d-4943-a9d2-f2f05368a17d",
"db_currency_id": "fd31735d-ed51-4745-b381-e64d0772fc9f",
"db_language_id": "28604f1c-77ac-450d-9a70-9bb3359b9922",
"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-30T17:20:40.4111315+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-30T17:20:40.4111315+00:00"
},
"company_id": "7fead67e-638c-4c6f-90e9-d0433c4e8beb",
"company_code": "sample string 12",
"db_address_id": "85bb4cd2-7fdf-4fb7-9ac5-d2a797297765",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "db9c0b5c-c7c0-405b-9dd0-4487495cef71",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c0f949cc-cbd7-48d2-b463-7b5b63ae9a12",
"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-30T17:20:40.4111315+00:00",
"date_create": "2026-08-30T17:20:40.4111315+00:00",
"date_update": "2026-08-30T17:20:40.4111315+00:00",
"updated_by_user_id": "b25d35d0-eba2-4aed-814c-37717e079f16",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-30T17:20:40.4111315+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-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-30T17:20:40.4111315+00:00",
"date_last_job": "2026-08-30T17:20:40.4111315+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-30T17:20:40.4111315+00:00",
"modified_dateutc": "2026-08-30T17:20:40.4111315+00:00",
"is_mobile_installation": true
},
"job_type_id": "9447023c-83cb-4d89-8a0b-82e35383e7f0",
"job_type_code": "sample string 7",
"job_type": {
"id": "01bbbb61-c3cd-4a97-bd8f-d05709da5877",
"name": "sample string 2",
"sales_organization_id": "bf787a8a-6591-4106-838b-d22edf4a227e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-30T17:20:40.4111315+00:00",
"code": "sample string 7"
},
"job_priority_id": "bf7ed0be-e080-406a-9277-df6fe9716ba3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e8113085-c0c3-46da-8413-19ab37f14f16",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ac16eae9-1c91-4626-8551-725b45bb2863",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fe42e868-e0e6-46b7-b1b7-010c59c6b334",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5691c831-fc9d-4943-a9d2-f2f05368a17d",
"db_currency_id": "fd31735d-ed51-4745-b381-e64d0772fc9f",
"db_language_id": "28604f1c-77ac-450d-9a70-9bb3359b9922",
"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-30T17:20:40.4111315+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-30T17:20:40.4111315+00:00"
},
"job_status_id": "0692d128-021b-4e68-b76c-e14093e10e28",
"job_status_code": "sample string 11",
"db_address_id": "d3f4e73e-1e0f-42c4-b5fb-3df14afbe383",
"contact_id": "8b48dc01-66ee-4f79-a75c-cfeaf466a6ed",
"requested_by_company_id": "ab54fb19-a3a0-4abd-8887-1bbab6bd38af",
"requested_by_contact_id": "41107618-298a-4675-b736-1b86c44266e9",
"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-30T17:20:40.4111315+00:00",
"due_date": "2026-08-30T17:20:40.4111315+00:00",
"date_create": "2026-08-30T17:20:40.4111315+00:00",
"date_update": "2026-08-30T17:20:40.4111315+00:00",
"date_closed": "2026-08-30T17:20:40.4111315+00:00",
"suggested_user_id": "6412d7ee-2351-4e45-912d-5ab312dbc274",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4eff352e-d5a1-446e-a133-58e2e18c0c4f",
"db_language_id": "18ce7669-fb61-4884-882d-9fc7b2c0d2e0",
"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-30T17:20:40.4111315+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f03343e6-1420-4167-90ec-e1f8a8d6d3c3",
"sales_organization": {
"id": "fe42e868-e0e6-46b7-b1b7-010c59c6b334",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5691c831-fc9d-4943-a9d2-f2f05368a17d",
"db_currency_id": "fd31735d-ed51-4745-b381-e64d0772fc9f",
"db_language_id": "28604f1c-77ac-450d-9a70-9bb3359b9922",
"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-30T17:20:40.4111315+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8afb4303-901e-4494-ae64-e48a1ab2ba5d",
"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": "1d1b2abb-37c0-4468-bd6a-f726fd69d76f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-30T17:20:40.4111315+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6ba17b1a-4e29-4619-8b4f-0af7706718ed"
},
"suggested_date_start": "2026-08-30T17:20:40.4111315+00:00",
"skill_id": "cf6195f9-f01d-4fca-b1c1-3779848644df",
"skill_code": "sample string 32",
"skill": {
"id": "e4654ade-6424-4029-9ba4-a4c05ab4e3bd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "15ea995c-3832-4b7c-ac63-95a442208f30",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fe42e868-e0e6-46b7-b1b7-010c59c6b334",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5691c831-fc9d-4943-a9d2-f2f05368a17d",
"db_currency_id": "fd31735d-ed51-4745-b381-e64d0772fc9f",
"db_language_id": "28604f1c-77ac-450d-9a70-9bb3359b9922",
"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-30T17:20:40.4111315+00:00"
},
"modified_dateutc": "2026-08-30T17:20:40.4111315+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7323c073-6acd-4774-ad2c-9b7520423fa7",
"date_reported_by_company": "2026-08-30T17:20:40.4111315+00:00",
"id2": 36,
"company_id": "3dd134e1-7759-4189-adb8-03ad47d52199",
"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": "9ede64a9-7352-416a-bcbb-da24bdaabaf3",
"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-30T17:20:40.4111315+00:00"
},
"work_instruction_details_id": "d8c77f99-01df-4969-b4fe-756e7baeac14",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c2f22f94-9166-402f-b076-7ca4975cf73d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f56f4d96-dceb-4320-88dc-16ee1f9d5637",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-30T17:20:40.4111315+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": "2b5b911d-c0dc-40b7-83a2-de2df8a0c0fb",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-30T17:20:40.4111315+00:00"
}