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": "ed0b5946-797a-4b6b-96fd-4e90a6a8fbf0",
"jobs_id": "f46e54d3-157e-424f-b947-ccdc5b116d32",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5634d7d4-7af9-403c-8925-fc4552718570",
"_parent_id": "d5c48368-7af9-4ec9-903d-d13f8bdae236",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6c01a5d3-2512-4e92-8356-fc25e232b53e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "29de963d-d30e-48aa-90fe-7d47a8f131ed",
"_parent_id": "a83c4667-e773-4010-8669-37d492e8eb27",
"root_parent_id": "15505a09-3d99-4c23-a333-b90382082475",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "14fb6e05-7abb-436b-98f0-cc1131197268",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8d2543aa-0436-44e5-bb29-11cf2975083d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ac405485-d736-4900-94f6-df405a4d57c3",
"_parent_code": "sample string 6",
"sales_organization_id": "daafe19e-ba90-440a-a5f7-09311a0ae17d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "20b38193-fb15-4bd2-b7c0-13ed5b367ecd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1372fa50-3668-4eef-a8e3-35451d40ca28",
"db_currency_id": "df8eaf4c-1a71-4a68-86d8-ce992582980d",
"db_language_id": "f30a9588-aa19-4972-84dd-91ff61c7cfb2",
"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": "2025-07-12T03:17:39.9029786+00:00"
},
"modified_dateutc": "2025-07-12T03:17:39.9029786+00:00"
},
"equipment_model_id": "f65e8e06-2767-447c-9296-b924f932b4a8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ee0e8115-507b-404e-9c25-005d82d4430f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "df3c8e0b-2329-4a5d-bcae-eba500845996",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "90e247ec-70b0-4675-b69c-0a7e36ecca50",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b62c1fd4-0f31-4bb3-a6d2-00c37cb635ae",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "20b38193-fb15-4bd2-b7c0-13ed5b367ecd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1372fa50-3668-4eef-a8e3-35451d40ca28",
"db_currency_id": "df8eaf4c-1a71-4a68-86d8-ce992582980d",
"db_language_id": "f30a9588-aa19-4972-84dd-91ff61c7cfb2",
"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": "2025-07-12T03:17:39.9029786+00:00"
},
"modified_dateutc": "2025-07-12T03:17:39.9029786+00:00"
},
"equipment_family_id": "cde99e9d-a837-4210-9657-70ba7f42df7e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8d2543aa-0436-44e5-bb29-11cf2975083d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ac405485-d736-4900-94f6-df405a4d57c3",
"_parent_code": "sample string 6",
"sales_organization_id": "daafe19e-ba90-440a-a5f7-09311a0ae17d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "20b38193-fb15-4bd2-b7c0-13ed5b367ecd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1372fa50-3668-4eef-a8e3-35451d40ca28",
"db_currency_id": "df8eaf4c-1a71-4a68-86d8-ce992582980d",
"db_language_id": "f30a9588-aa19-4972-84dd-91ff61c7cfb2",
"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": "2025-07-12T03:17:39.9029786+00:00"
},
"modified_dateutc": "2025-07-12T03:17:39.9029786+00:00"
},
"date_in_production_since": "2025-07-12T03:17:39.9029786+00:00",
"date_out_of_production_since": "2025-07-12T03:17:39.9029786+00:00",
"date_end_support": "2025-07-12T03:17:39.9029786+00:00",
"sales_organization_id": "0802493c-031a-4949-9210-c2beb70dccff",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "20b38193-fb15-4bd2-b7c0-13ed5b367ecd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1372fa50-3668-4eef-a8e3-35451d40ca28",
"db_currency_id": "df8eaf4c-1a71-4a68-86d8-ce992582980d",
"db_language_id": "f30a9588-aa19-4972-84dd-91ff61c7cfb2",
"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": "2025-07-12T03:17:39.9029786+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": "2025-07-12T03:17:39.9029786+00:00"
},
"project_status_id": "4bee44ac-71dd-4964-ba9b-77772937a63f",
"project_status_code": "sample string 10",
"project_status": {
"id": "e13fedb5-fe5e-4434-ab11-cf6f0b553fe4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "38e44e56-43c2-41ce-be25-aa6b3e8f3479",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "20b38193-fb15-4bd2-b7c0-13ed5b367ecd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1372fa50-3668-4eef-a8e3-35451d40ca28",
"db_currency_id": "df8eaf4c-1a71-4a68-86d8-ce992582980d",
"db_language_id": "f30a9588-aa19-4972-84dd-91ff61c7cfb2",
"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": "2025-07-12T03:17:39.9029786+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-07-12T03:17:39.9029786+00:00"
},
"company_id": "2672e1ac-514f-4eec-b495-16b59fb64055",
"company_code": "sample string 12",
"db_address_id": "22bc0db9-fbe8-4fc8-965d-5acce95d7862",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7ac9a6cb-10ad-47ce-bb1e-77130b2e111b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2912db97-8336-4ceb-aaa6-6e59c0ab03bb",
"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": "2025-07-12T03:17:39.9029786+00:00",
"date_create": "2025-07-12T03:17:39.9029786+00:00",
"date_update": "2025-07-12T03:17:39.9029786+00:00",
"updated_by_user_id": "38608ed5-1b81-4dce-8217-898c6f6b2220",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-07-12T03:17:39.9029786+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": "2025-07-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-07-12T03:17:39.9029786+00:00",
"date_last_job": "2025-07-12T03:17:39.9029786+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-07-12T03:17:39.9029786+00:00",
"modified_dateutc": "2025-07-12T03:17:39.9029786+00:00",
"is_mobile_installation": true
},
"job_type_id": "30c1c5de-f28a-4bf2-a9fa-4c0c648dec3d",
"job_type_code": "sample string 7",
"job_type": {
"id": "f80ee12d-d531-42c8-9ddf-90675585aa28",
"name": "sample string 2",
"sales_organization_id": "e1b23be9-0f63-436f-8184-4e4647c9928d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-07-12T03:17:39.9029786+00:00",
"code": "sample string 7"
},
"job_priority_id": "88a3d752-fa71-4fa2-8262-c5fcfd08a98c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "af5e892d-e627-47ce-9a04-b0e66d52886e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "140732c1-c475-4a68-a14b-d40c7cc11ead",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "20b38193-fb15-4bd2-b7c0-13ed5b367ecd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1372fa50-3668-4eef-a8e3-35451d40ca28",
"db_currency_id": "df8eaf4c-1a71-4a68-86d8-ce992582980d",
"db_language_id": "f30a9588-aa19-4972-84dd-91ff61c7cfb2",
"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": "2025-07-12T03:17:39.9029786+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-07-12T03:17:39.9029786+00:00"
},
"job_status_id": "ef56b9d4-14b5-455e-8b63-8b28096b9626",
"job_status_code": "sample string 11",
"db_address_id": "3b9f4fc9-5de8-4490-95fc-10fbf85806e4",
"contact_id": "5a530f90-8dd3-4588-b8ca-ae480413cd2c",
"requested_by_company_id": "8cb9e7c7-7d86-4f3d-8f3d-8f2444457257",
"requested_by_contact_id": "82197753-8e46-42c8-b3c0-a8e1f27a1105",
"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": "2025-07-12T03:17:39.9029786+00:00",
"due_date": "2025-07-12T03:17:39.9029786+00:00",
"date_create": "2025-07-12T03:17:39.9029786+00:00",
"date_update": "2025-07-12T03:17:39.9029786+00:00",
"date_closed": "2025-07-12T03:17:39.9029786+00:00",
"suggested_user_id": "229e12e1-8446-438e-b685-24322e37901b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0a998235-93ff-49fd-bffc-71625e6445c9",
"db_language_id": "f142d659-9052-4732-afa5-66205ffcf62d",
"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": "2025-07-12T03:17:39.9029786+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "68732116-d3b5-421a-86dd-785b2d951dbb",
"sales_organization": {
"id": "20b38193-fb15-4bd2-b7c0-13ed5b367ecd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1372fa50-3668-4eef-a8e3-35451d40ca28",
"db_currency_id": "df8eaf4c-1a71-4a68-86d8-ce992582980d",
"db_language_id": "f30a9588-aa19-4972-84dd-91ff61c7cfb2",
"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": "2025-07-12T03:17:39.9029786+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d5eaf446-14fa-41ef-81bf-a07b83f981cb",
"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": "4b2fb13b-8b85-44c9-936b-6855eacf6845",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-07-12T03:17:39.9029786+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7e61c93e-e36c-4815-9fd0-4c0971430ff5"
},
"suggested_date_start": "2025-07-12T03:17:39.9029786+00:00",
"skill_id": "e950eb03-871b-49a2-ac97-f9c417567f67",
"skill_code": "sample string 32",
"skill": {
"id": "fb4bac41-40d8-4613-b04f-e5478b9cb32f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c19b26d9-5585-4409-8fb8-4e978b20cac5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "20b38193-fb15-4bd2-b7c0-13ed5b367ecd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1372fa50-3668-4eef-a8e3-35451d40ca28",
"db_currency_id": "df8eaf4c-1a71-4a68-86d8-ce992582980d",
"db_language_id": "f30a9588-aa19-4972-84dd-91ff61c7cfb2",
"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": "2025-07-12T03:17:39.9029786+00:00"
},
"modified_dateutc": "2025-07-12T03:17:39.9029786+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "cf5e2e70-389e-44a9-88f4-18f159e0921b",
"date_reported_by_company": "2025-07-12T03:17:39.9029786+00:00",
"id2": 36,
"company_id": "de489bf1-7619-4d41-a1e6-c2f18cfd6316",
"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": "3492937a-b601-4447-a175-8a1110b0f7fe",
"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": "2025-07-12T03:17:39.9029786+00:00"
},
"work_instruction_details_id": "c7c57b36-38df-4c35-a711-6127c7b50270",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6578744c-9505-4119-895c-61e6ef1d4743",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "980902c8-04ab-459a-bc28-d6cf5909ab9e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-07-12T03:17:39.9029786+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": "67154988-d253-4075-bf55-87cf7cf87b34",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-07-12T03:17:39.918606+00:00"
}