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": "cdad55e0-510f-4582-a627-de294ff513e3",
"jobs_id": "0468e744-223e-47cc-ae8c-5feff48935d6",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "266d7b51-2dea-4436-b9b8-e3278210b20f",
"_parent_id": "a3166936-334b-4bd0-8bf9-f66e8b3f52fa",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "62a23e70-118d-4945-9804-7e1ba3aec434",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b2ca6a39-5ab8-44cb-b673-9d49b964b802",
"_parent_id": "d3222443-16c2-4609-8261-8344cbe9efff",
"root_parent_id": "41646120-243a-4f9d-91cc-6efcf6434d06",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ab3f7b60-2213-409b-b95c-3339c02ee62d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6903a36d-a2fd-401a-814a-cc2b693900f2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8e19be26-aab4-4af7-ba49-43a8e061338d",
"_parent_code": "sample string 6",
"sales_organization_id": "dbbc28a8-d3e1-4b7d-b33c-8448db472cbd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c792011b-f000-4595-b830-3bb25b475bfa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc1ae2ac-6ad7-4f19-ae3a-c7d70bf7429f",
"db_currency_id": "c5c54da7-53a9-4871-931a-fa617dd37754",
"db_language_id": "5d9a6306-9cac-407c-93e0-3b8d2fdd9254",
"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": "2024-12-19T16:52:02.1244641+00:00"
},
"modified_dateutc": "2024-12-19T16:52:02.1244641+00:00"
},
"equipment_model_id": "b71ca62e-c676-4c6c-9ab2-c650369f48e3",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "cd51c027-185c-47e0-ae36-fa5990505270",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2d162366-576e-4f99-b0af-0420a0b85677",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "fed80fa1-0708-465a-be77-c22388a5b1b5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bbba1428-e197-4513-afb9-b0bf31c161a2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c792011b-f000-4595-b830-3bb25b475bfa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc1ae2ac-6ad7-4f19-ae3a-c7d70bf7429f",
"db_currency_id": "c5c54da7-53a9-4871-931a-fa617dd37754",
"db_language_id": "5d9a6306-9cac-407c-93e0-3b8d2fdd9254",
"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": "2024-12-19T16:52:02.1244641+00:00"
},
"modified_dateutc": "2024-12-19T16:52:02.1244641+00:00"
},
"equipment_family_id": "040410c1-58a2-4e7a-a29d-ef1da44d4dba",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6903a36d-a2fd-401a-814a-cc2b693900f2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8e19be26-aab4-4af7-ba49-43a8e061338d",
"_parent_code": "sample string 6",
"sales_organization_id": "dbbc28a8-d3e1-4b7d-b33c-8448db472cbd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c792011b-f000-4595-b830-3bb25b475bfa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc1ae2ac-6ad7-4f19-ae3a-c7d70bf7429f",
"db_currency_id": "c5c54da7-53a9-4871-931a-fa617dd37754",
"db_language_id": "5d9a6306-9cac-407c-93e0-3b8d2fdd9254",
"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": "2024-12-19T16:52:02.1244641+00:00"
},
"modified_dateutc": "2024-12-19T16:52:02.1244641+00:00"
},
"date_in_production_since": "2024-12-19T16:52:02.1244641+00:00",
"date_out_of_production_since": "2024-12-19T16:52:02.1244641+00:00",
"date_end_support": "2024-12-19T16:52:02.1244641+00:00",
"sales_organization_id": "d0244726-18f5-4c97-bda3-544f06e6e439",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c792011b-f000-4595-b830-3bb25b475bfa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc1ae2ac-6ad7-4f19-ae3a-c7d70bf7429f",
"db_currency_id": "c5c54da7-53a9-4871-931a-fa617dd37754",
"db_language_id": "5d9a6306-9cac-407c-93e0-3b8d2fdd9254",
"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": "2024-12-19T16:52:02.1244641+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": "2024-12-19T16:52:02.1244641+00:00"
},
"project_status_id": "d092b566-2fc7-4d0f-8d42-465a5a03fd59",
"project_status_code": "sample string 10",
"project_status": {
"id": "9a58e0f7-b188-4034-9c0e-c76334af0651",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a2f9b5bc-676b-4d12-a273-57be71421b04",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c792011b-f000-4595-b830-3bb25b475bfa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc1ae2ac-6ad7-4f19-ae3a-c7d70bf7429f",
"db_currency_id": "c5c54da7-53a9-4871-931a-fa617dd37754",
"db_language_id": "5d9a6306-9cac-407c-93e0-3b8d2fdd9254",
"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": "2024-12-19T16:52:02.1244641+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-12-19T16:52:02.1244641+00:00"
},
"company_id": "891ddb53-b54c-47b2-a6a5-0ea1f875a340",
"company_code": "sample string 12",
"db_address_id": "1f60693d-c107-47a3-a4ac-bbb05aa4c2cd",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "43819a87-9baf-47bf-9dd7-345d1f67a92c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "08141a7b-1463-40a2-ace8-2dbb9137ee06",
"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": "2024-12-19T16:52:02.1244641+00:00",
"date_create": "2024-12-19T16:52:02.1244641+00:00",
"date_update": "2024-12-19T16:52:02.1244641+00:00",
"updated_by_user_id": "ad5dc424-ad37-4eb1-ab00-77e9be94a831",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-12-19T16:52:02.1244641+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": "2024-12-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-12-19T16:52:02.1244641+00:00",
"date_last_job": "2024-12-19T16:52:02.1244641+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-12-19T16:52:02.1244641+00:00",
"modified_dateutc": "2024-12-19T16:52:02.1244641+00:00",
"is_mobile_installation": true
},
"job_type_id": "a2a57841-5140-4f01-81e1-008fcc8ee754",
"job_type_code": "sample string 7",
"job_type": {
"id": "bd30b63a-508b-4c38-8f5f-4fe7eaf05282",
"name": "sample string 2",
"sales_organization_id": "7fdfe4d8-9803-40b7-9a10-b8ff02867950",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-12-19T16:52:02.1244641+00:00",
"code": "sample string 7"
},
"job_priority_id": "4c7b9d8c-59be-4e7d-804d-c4bbc70e773c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8a023635-f1b8-41c3-acc1-9ac7e38ae3d3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "28a8dbea-db13-4e7a-865b-3691a2b7badf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c792011b-f000-4595-b830-3bb25b475bfa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc1ae2ac-6ad7-4f19-ae3a-c7d70bf7429f",
"db_currency_id": "c5c54da7-53a9-4871-931a-fa617dd37754",
"db_language_id": "5d9a6306-9cac-407c-93e0-3b8d2fdd9254",
"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": "2024-12-19T16:52:02.1244641+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-12-19T16:52:02.1244641+00:00"
},
"job_status_id": "64d5373f-6a44-47d8-b061-669789aecc92",
"job_status_code": "sample string 11",
"db_address_id": "8b69a0d9-2a58-485b-9486-8f2ab84ad0f3",
"contact_id": "9c8fe02b-b7fc-4971-b69c-a89f4dd7cb67",
"requested_by_company_id": "e5100540-4d6a-44f0-9caf-63278dfda274",
"requested_by_contact_id": "196b4cae-eaed-40c6-b045-5f978fb80224",
"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": "2024-12-19T16:52:02.1244641+00:00",
"due_date": "2024-12-19T16:52:02.1244641+00:00",
"date_create": "2024-12-19T16:52:02.1244641+00:00",
"date_update": "2024-12-19T16:52:02.1244641+00:00",
"date_closed": "2024-12-19T16:52:02.1244641+00:00",
"suggested_user_id": "05a8b58f-6047-4844-8dc7-0787630acbab",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7c23cf70-5c7b-4c40-8295-f5801ede90de",
"db_language_id": "7a283464-90e5-4ffd-a188-733dfceddd62",
"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": "2024-12-19T16:52:02.1244641+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b5df2417-a300-4a56-897c-7b75b413fd31",
"sales_organization": {
"id": "c792011b-f000-4595-b830-3bb25b475bfa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc1ae2ac-6ad7-4f19-ae3a-c7d70bf7429f",
"db_currency_id": "c5c54da7-53a9-4871-931a-fa617dd37754",
"db_language_id": "5d9a6306-9cac-407c-93e0-3b8d2fdd9254",
"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": "2024-12-19T16:52:02.1244641+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "386ff88c-95f9-4101-bf1a-2a0172f0c44d",
"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": "5f3f86ed-ac55-4ef1-99f2-2a36c1cec073",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-12-19T16:52:02.1244641+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b8761f33-73b9-47a3-8d56-181963bebb8f"
},
"suggested_date_start": "2024-12-19T16:52:02.1244641+00:00",
"skill_id": "088ced8c-787e-4394-a009-e21250e66630",
"skill_code": "sample string 32",
"skill": {
"id": "e9d05819-e108-4c6c-9b02-4297081acf31",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "eeb8aadd-a46f-45fe-b506-fa10ce8be5e3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c792011b-f000-4595-b830-3bb25b475bfa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc1ae2ac-6ad7-4f19-ae3a-c7d70bf7429f",
"db_currency_id": "c5c54da7-53a9-4871-931a-fa617dd37754",
"db_language_id": "5d9a6306-9cac-407c-93e0-3b8d2fdd9254",
"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": "2024-12-19T16:52:02.1244641+00:00"
},
"modified_dateutc": "2024-12-19T16:52:02.1244641+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "b0d063b0-5ac2-4223-9a34-06bdb850e0aa",
"date_reported_by_company": "2024-12-19T16:52:02.1244641+00:00",
"id2": 36,
"company_id": "5f5b10c5-a3a4-4c8c-99b8-c12bc0148eb0",
"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": "a69208ff-eb20-4686-a688-b13eb277ae73",
"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": "2024-12-19T16:52:02.1244641+00:00"
},
"work_instruction_details_id": "80ed1345-ae6e-4a16-befc-9c41f525e0eb",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "56e1b32d-7b34-45da-ba0c-4006df188910",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "eaf6d762-6da6-4b80-ae3a-0e272f9b76d6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-12-19T16:52:02.1244641+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": "16558859-55f1-42b4-822d-36c1e4436639",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-12-19T16:52:02.1244641+00:00"
}