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": "3016eee5-8fe0-4b89-b0a9-43c7eb917d6c",
"jobs_id": "da38db1a-694b-41af-a58f-db59cdc88c27",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "aa0d6bb0-d5bd-4e76-bfda-a02bff6a1a86",
"_parent_id": "0c92e49e-a125-4fed-8c1e-c049f7058faf",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c07b4d5c-f81b-453e-9539-bc425f267440",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0c0b38ef-edc1-480a-b7f7-8e966109b3b8",
"_parent_id": "8a1eb341-ae16-45d2-8803-09db45016fd1",
"root_parent_id": "c0cdf281-a306-4ad4-abdf-28db0a525f36",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f5b9fa6a-64b6-4324-aa2b-cdbd3d55a297",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "979987e2-3fd5-4334-bf5a-673e5f135371",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f6871892-d1c0-4701-b6b1-a9574d8cdd21",
"_parent_code": "sample string 6",
"sales_organization_id": "1aadfc36-64b9-4ce9-9d7b-6d7647efc0a3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3acba549-f841-47da-8f8a-9405b81e68c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c62bd151-7c4d-4310-9e69-e2f87e0b1ab6",
"db_currency_id": "85e140e0-15ee-45a4-9ef7-7af0d0a959b7",
"db_language_id": "8982ee9d-2222-4a79-aaca-7de282d153ff",
"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-04-24T08:20:06.238583+00:00"
},
"modified_dateutc": "2024-04-24T08:20:06.238583+00:00"
},
"equipment_model_id": "f9f59d07-0609-4fca-b651-701fc2119520",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "af5245dd-c27e-4a26-8dc1-0c030b95c169",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "181e9e0d-324d-460d-818e-72ca22b2a608",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c4700113-1279-4fb5-8f6c-c499fd8963c4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "09009946-bab0-494e-adfa-d641b3e9ca21",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3acba549-f841-47da-8f8a-9405b81e68c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c62bd151-7c4d-4310-9e69-e2f87e0b1ab6",
"db_currency_id": "85e140e0-15ee-45a4-9ef7-7af0d0a959b7",
"db_language_id": "8982ee9d-2222-4a79-aaca-7de282d153ff",
"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-04-24T08:20:06.238583+00:00"
},
"modified_dateutc": "2024-04-24T08:20:06.238583+00:00"
},
"equipment_family_id": "a254da57-1a75-4248-a4c5-59af1cc6b9da",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "979987e2-3fd5-4334-bf5a-673e5f135371",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f6871892-d1c0-4701-b6b1-a9574d8cdd21",
"_parent_code": "sample string 6",
"sales_organization_id": "1aadfc36-64b9-4ce9-9d7b-6d7647efc0a3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3acba549-f841-47da-8f8a-9405b81e68c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c62bd151-7c4d-4310-9e69-e2f87e0b1ab6",
"db_currency_id": "85e140e0-15ee-45a4-9ef7-7af0d0a959b7",
"db_language_id": "8982ee9d-2222-4a79-aaca-7de282d153ff",
"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-04-24T08:20:06.238583+00:00"
},
"modified_dateutc": "2024-04-24T08:20:06.238583+00:00"
},
"date_in_production_since": "2024-04-24T08:20:06.238583+00:00",
"date_out_of_production_since": "2024-04-24T08:20:06.238583+00:00",
"date_end_support": "2024-04-24T08:20:06.238583+00:00",
"sales_organization_id": "19e0dc51-a77d-4742-92af-5390be4a8657",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3acba549-f841-47da-8f8a-9405b81e68c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c62bd151-7c4d-4310-9e69-e2f87e0b1ab6",
"db_currency_id": "85e140e0-15ee-45a4-9ef7-7af0d0a959b7",
"db_language_id": "8982ee9d-2222-4a79-aaca-7de282d153ff",
"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-04-24T08:20:06.238583+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-04-24T08:20:06.238583+00:00"
},
"project_status_id": "27bb549a-0ded-4096-be5a-0d17157e851f",
"project_status_code": "sample string 10",
"project_status": {
"id": "e1b5c119-1fdb-4ddc-9002-4220cd2412de",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "81ae683a-49b9-4239-8427-b05f42b78cb1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3acba549-f841-47da-8f8a-9405b81e68c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c62bd151-7c4d-4310-9e69-e2f87e0b1ab6",
"db_currency_id": "85e140e0-15ee-45a4-9ef7-7af0d0a959b7",
"db_language_id": "8982ee9d-2222-4a79-aaca-7de282d153ff",
"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-04-24T08:20:06.238583+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-04-24T08:20:06.238583+00:00"
},
"company_id": "50085109-bac0-4e25-9e3a-242bfce9a170",
"company_code": "sample string 12",
"db_address_id": "9fdb02ff-64ce-4bd8-b186-959b52e6717e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b34d15b5-dc99-455d-9bba-2bb2957bc385",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d64ff4cb-7b4d-4c5a-b3cb-8f05f62e9189",
"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-04-24T08:20:06.238583+00:00",
"date_create": "2024-04-24T08:20:06.238583+00:00",
"date_update": "2024-04-24T08:20:06.238583+00:00",
"updated_by_user_id": "3aa8560e-5373-4adc-a787-868d46b8748b",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-04-24T08:20:06.238583+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-04-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-04-24T08:20:06.238583+00:00",
"date_last_job": "2024-04-24T08:20:06.238583+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-04-24T08:20:06.238583+00:00",
"modified_dateutc": "2024-04-24T08:20:06.238583+00:00",
"is_mobile_installation": true
},
"job_type_id": "6f4bb109-4ab5-45e9-a4ed-46c6f95608f4",
"job_type_code": "sample string 7",
"job_type": {
"id": "a29b93ba-4d41-4dfd-aaeb-d0d5399d1bef",
"name": "sample string 2",
"sales_organization_id": "dac874e0-21c2-4c6e-9f2a-04917fc950de",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-04-24T08:20:06.238583+00:00",
"code": "sample string 7"
},
"job_priority_id": "ed5f1a8a-c1dd-454a-be5e-3aac989d53e3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "888ed2ae-0e90-412e-b211-47044f4e6297",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "95ce5e14-2c7b-4445-9334-5ccf1ff79ede",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3acba549-f841-47da-8f8a-9405b81e68c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c62bd151-7c4d-4310-9e69-e2f87e0b1ab6",
"db_currency_id": "85e140e0-15ee-45a4-9ef7-7af0d0a959b7",
"db_language_id": "8982ee9d-2222-4a79-aaca-7de282d153ff",
"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-04-24T08:20:06.238583+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-04-24T08:20:06.238583+00:00"
},
"job_status_id": "d4c180c8-23d3-4951-ad17-e97676fa9c90",
"job_status_code": "sample string 11",
"db_address_id": "6cbbbaa3-2ea2-40e3-83a5-20e9b3696edd",
"contact_id": "d70c9364-7b53-4b4a-b297-bdd9834c16ea",
"requested_by_company_id": "76ccb9c2-fe23-4deb-9f7c-10cc1ce01542",
"requested_by_contact_id": "36bc337c-1860-4a60-96c1-d13eac4c2950",
"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-04-24T08:20:06.238583+00:00",
"due_date": "2024-04-24T08:20:06.238583+00:00",
"date_create": "2024-04-24T08:20:06.238583+00:00",
"date_update": "2024-04-24T08:20:06.238583+00:00",
"date_closed": "2024-04-24T08:20:06.238583+00:00",
"suggested_user_id": "f63b2bfd-7457-4842-bb0b-c7554f9fdcbf",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "47b6bef4-8e15-40a0-9e8b-17eb4878f74a",
"db_language_id": "84c8700e-badf-420a-b4b7-a52a4019fd2a",
"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-04-24T08:20:06.238583+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "887d7ab4-fe1f-4d1b-a81f-a5562a576f4e",
"sales_organization": {
"id": "3acba549-f841-47da-8f8a-9405b81e68c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c62bd151-7c4d-4310-9e69-e2f87e0b1ab6",
"db_currency_id": "85e140e0-15ee-45a4-9ef7-7af0d0a959b7",
"db_language_id": "8982ee9d-2222-4a79-aaca-7de282d153ff",
"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-04-24T08:20:06.238583+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6098d9c9-eea0-410d-a34a-f1342c3622a3",
"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": "912c58b1-9834-4d97-8b29-5b08496cf529",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-04-24T08:20:06.238583+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d21b783d-f8dc-4497-a5d8-df38379b7f66"
},
"suggested_date_start": "2024-04-24T08:20:06.238583+00:00",
"skill_id": "241624ae-f124-4c53-859d-872301062128",
"skill_code": "sample string 32",
"skill": {
"id": "4f441b47-04e3-4128-92ed-70ee7a6dd153",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e095ff48-c2b1-418d-a3a8-c77a3a7eb640",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3acba549-f841-47da-8f8a-9405b81e68c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c62bd151-7c4d-4310-9e69-e2f87e0b1ab6",
"db_currency_id": "85e140e0-15ee-45a4-9ef7-7af0d0a959b7",
"db_language_id": "8982ee9d-2222-4a79-aaca-7de282d153ff",
"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-04-24T08:20:06.238583+00:00"
},
"modified_dateutc": "2024-04-24T08:20:06.238583+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bac6dae8-f004-4d1d-9814-1f281fa562d8",
"date_reported_by_company": "2024-04-24T08:20:06.238583+00:00",
"id2": 36,
"company_id": "b758fead-26d7-4c86-bc90-368e47e4e323",
"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": "aa8d1002-2389-4bc1-b91c-3a1da0369b71",
"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-04-24T08:20:06.238583+00:00"
},
"work_instruction_details_id": "8a7e2b22-500c-4fbb-93c5-cbf361b2b282",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "1de74ca8-3dcb-4cac-9d33-eb8b06de4233",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7d53758d-f8a4-47b1-8063-7f487cabe059",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-04-24T08:20:06.238583+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": "e23078a9-e9c0-407a-b911-d3f2181fd6ff",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-04-24T08:20:06.238583+00:00"
}