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": "ac842da8-d872-4546-b583-a8f668208d75",
"jobs_id": "e48e1491-3bbb-4c59-ad01-55d241e14ca1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "af7bf25c-4eea-4641-9bf2-326714912417",
"_parent_id": "3d722fc0-db1f-4942-a813-f327278a1a24",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1f72efac-ce98-4a10-94f9-4847d7f11a84",
"project_reference_back_office": "sample string 5",
"project": {
"id": "92fd97c0-59a4-44f3-87c7-653be83a52cb",
"_parent_id": "16428ee7-c35b-447f-8535-a5a3e9a09c11",
"root_parent_id": "e8ae92b4-2c26-4267-a010-7f5f53fbd316",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "365938a8-7bdb-4a23-962d-b094ad929e5d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "242c5b42-2e44-49d6-8e2a-1a9dedf47f51",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9a1de277-86ff-4433-b614-8fbd08ae0969",
"_parent_code": "sample string 6",
"sales_organization_id": "3915138f-a164-46f8-9075-20f0dfc192a0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d6a8a9c0-5599-40cb-975e-53c9c602b5b4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f573448d-4c35-4b21-becc-d014cd45bfdf",
"db_currency_id": "c04b49ad-624b-4062-8b68-21cf31efe9b0",
"db_language_id": "073e081d-cd23-4ee1-a30a-99cb370d9756",
"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": "2023-03-30T19:52:49.819697+00:00"
},
"modified_dateutc": "2023-03-30T19:52:49.819697+00:00"
},
"equipment_model_id": "76482913-0938-4f12-a22f-4e56f4c5c56c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b50cb45b-b4a8-4859-b8d4-41a0ddf7bdbd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f85e01c2-73b8-4c6b-b3dc-1e55978457ac",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4d4053d8-2386-4926-b886-536686a1fe73",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "970d6e1c-e79c-4da4-8b6a-aa1a3d78b1d4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d6a8a9c0-5599-40cb-975e-53c9c602b5b4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f573448d-4c35-4b21-becc-d014cd45bfdf",
"db_currency_id": "c04b49ad-624b-4062-8b68-21cf31efe9b0",
"db_language_id": "073e081d-cd23-4ee1-a30a-99cb370d9756",
"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": "2023-03-30T19:52:49.819697+00:00"
},
"modified_dateutc": "2023-03-30T19:52:49.819697+00:00"
},
"equipment_family_id": "ace226c4-8efa-49a4-a1d7-4dcf6993ee1c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "242c5b42-2e44-49d6-8e2a-1a9dedf47f51",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9a1de277-86ff-4433-b614-8fbd08ae0969",
"_parent_code": "sample string 6",
"sales_organization_id": "3915138f-a164-46f8-9075-20f0dfc192a0",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d6a8a9c0-5599-40cb-975e-53c9c602b5b4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f573448d-4c35-4b21-becc-d014cd45bfdf",
"db_currency_id": "c04b49ad-624b-4062-8b68-21cf31efe9b0",
"db_language_id": "073e081d-cd23-4ee1-a30a-99cb370d9756",
"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": "2023-03-30T19:52:49.819697+00:00"
},
"modified_dateutc": "2023-03-30T19:52:49.819697+00:00"
},
"date_in_production_since": "2023-03-30T19:52:49.819697+00:00",
"date_out_of_production_since": "2023-03-30T19:52:49.819697+00:00",
"date_end_support": "2023-03-30T19:52:49.819697+00:00",
"sales_organization_id": "5739ba32-255d-46ab-8be3-e07c899c2496",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d6a8a9c0-5599-40cb-975e-53c9c602b5b4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f573448d-4c35-4b21-becc-d014cd45bfdf",
"db_currency_id": "c04b49ad-624b-4062-8b68-21cf31efe9b0",
"db_language_id": "073e081d-cd23-4ee1-a30a-99cb370d9756",
"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": "2023-03-30T19:52:49.819697+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": "2023-03-30T19:52:49.8353219+00:00"
},
"project_status_id": "7df5eedd-f2e0-4a03-aa65-61a55c7ec159",
"project_status_code": "sample string 10",
"project_status": {
"id": "44cb5ef4-b10d-4df2-9444-4be5e47df5a1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "39886858-b947-4ce8-8cff-34e73cc606cb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d6a8a9c0-5599-40cb-975e-53c9c602b5b4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f573448d-4c35-4b21-becc-d014cd45bfdf",
"db_currency_id": "c04b49ad-624b-4062-8b68-21cf31efe9b0",
"db_language_id": "073e081d-cd23-4ee1-a30a-99cb370d9756",
"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": "2023-03-30T19:52:49.819697+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2023-03-30T19:52:49.8353219+00:00"
},
"company_id": "8a9dcd66-0ff3-462b-8099-e90d25888ad6",
"company_code": "sample string 12",
"db_address_id": "c8d6f774-d6fc-495f-918e-dba94c1540c3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "11f1d215-1173-4534-8464-9e51c70b7f42",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3eb65aed-9c0f-444a-8514-75678ac1b84a",
"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": "2023-03-30T19:52:49.8353219+00:00",
"date_create": "2023-03-30T19:52:49.8353219+00:00",
"date_update": "2023-03-30T19:52:49.8353219+00:00",
"updated_by_user_id": "ae375876-8441-41e1-a502-10549653b006",
"customer_reference": "sample string 28",
"warranty_date_until": "2023-03-30T19:52:49.8353219+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": "2023-03-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2023-03-30T19:52:49.8353219+00:00",
"date_last_job": "2023-03-30T19:52:49.8353219+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2023-03-30T19:52:49.8353219+00:00",
"modified_dateutc": "2023-03-30T19:52:49.8353219+00:00",
"is_mobile_installation": true
},
"job_type_id": "989b4923-3cf4-46fb-b5cd-dd64ea41adc5",
"job_type_code": "sample string 7",
"job_type": {
"id": "de9531f3-b2cb-49f3-8733-890a8bb5bf6c",
"name": "sample string 2",
"sales_organization_id": "0941dec8-200e-4638-9a5b-779471b94dd8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2023-03-30T19:52:49.8353219+00:00",
"code": "sample string 7"
},
"job_priority_id": "4bb561a6-1e5a-4464-953d-f4ddc67125d6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "caecf6c5-e7cb-476f-a7a7-d5a40dec744e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "150608e8-a2bf-4599-9483-2ea8c64d6d94",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d6a8a9c0-5599-40cb-975e-53c9c602b5b4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f573448d-4c35-4b21-becc-d014cd45bfdf",
"db_currency_id": "c04b49ad-624b-4062-8b68-21cf31efe9b0",
"db_language_id": "073e081d-cd23-4ee1-a30a-99cb370d9756",
"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": "2023-03-30T19:52:49.819697+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2023-03-30T19:52:49.8353219+00:00"
},
"job_status_id": "856e2aa5-6327-4134-8a85-bff95b250388",
"job_status_code": "sample string 11",
"db_address_id": "88f11de4-23c8-4e0a-a138-50b2d760cac8",
"contact_id": "234796b4-e364-4ec2-ac75-59bd2c86851f",
"requested_by_company_id": "03192b9b-f03b-43e8-9d84-73aaa97419e7",
"requested_by_contact_id": "2c81363f-af2d-4595-b8b7-f76ca16d6d91",
"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": "2023-03-30T19:52:49.8353219+00:00",
"due_date": "2023-03-30T19:52:49.8353219+00:00",
"date_create": "2023-03-30T19:52:49.8353219+00:00",
"date_update": "2023-03-30T19:52:49.8353219+00:00",
"date_closed": "2023-03-30T19:52:49.8353219+00:00",
"suggested_user_id": "d085f647-39b8-4754-8b7e-b714b858d463",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b1f53768-19f7-4f5b-807e-ab2bcb9a9221",
"db_language_id": "28ec1847-f4f7-4166-ad59-a4437d68f52c",
"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": "2023-03-30T19:52:49.8353219+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d230cf4a-336d-42c3-81b8-41fce1c8ba68",
"sales_organization": {
"id": "d6a8a9c0-5599-40cb-975e-53c9c602b5b4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f573448d-4c35-4b21-becc-d014cd45bfdf",
"db_currency_id": "c04b49ad-624b-4062-8b68-21cf31efe9b0",
"db_language_id": "073e081d-cd23-4ee1-a30a-99cb370d9756",
"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": "2023-03-30T19:52:49.819697+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6c3eb815-ca58-4d2a-8041-c3f959f04bac",
"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": "26cce187-5249-47ec-91cc-5986d08896d2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2023-03-30T19:52:49.8353219+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c6405e3c-c137-48f2-b699-5b68155f2131"
},
"suggested_date_start": "2023-03-30T19:52:49.8353219+00:00",
"skill_id": "05f43e01-3d17-4ff5-9f5a-73afdff873a9",
"skill_code": "sample string 32",
"skill": {
"id": "5442b0b6-f2d9-4cbe-a5cc-cc397f546807",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a3696be0-e21e-49f8-a98f-8a9ab24ffb6d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d6a8a9c0-5599-40cb-975e-53c9c602b5b4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f573448d-4c35-4b21-becc-d014cd45bfdf",
"db_currency_id": "c04b49ad-624b-4062-8b68-21cf31efe9b0",
"db_language_id": "073e081d-cd23-4ee1-a30a-99cb370d9756",
"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": "2023-03-30T19:52:49.819697+00:00"
},
"modified_dateutc": "2023-03-30T19:52:49.8353219+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ff30113f-1c15-42c4-9814-feaf52137c88",
"date_reported_by_company": "2023-03-30T19:52:49.8353219+00:00",
"id2": 36,
"company_id": "d64e69f1-fa83-4612-a4b4-4def56d9a09a",
"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": "62de86c8-dc7d-4130-a964-b0c89481f4bb",
"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": "2023-03-30T19:52:49.8353219+00:00"
},
"work_instruction_details_id": "5b5884ea-4185-4596-9f71-4e4d35492b60",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7784794e-efd7-43fe-9498-157d7fe6184a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a22adaf2-9da7-4c59-9ca6-33fee2f3d3d3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2023-03-30T19:52:49.8353219+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": "1dc2a051-5de8-4793-8840-07e7680b7a14",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2023-03-30T19:52:49.8353219+00:00"
}