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": "fb112ee1-85ad-450e-80a8-1f57ae12b3f7",
"jobs_id": "1dee9607-ae77-4fa3-a09d-04271de9cded",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1c4b90c2-cb70-460e-8074-b4d1bab96f0b",
"_parent_id": "187f660a-ac44-4168-b2d6-3863dc4e61c2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9c0bf4ad-5c9b-408d-9f64-64d26e8b7564",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7dc917e3-02ce-46b5-bf58-e9db0e4be10b",
"_parent_id": "d63f09d6-85bc-46b2-95db-5874cc4603c8",
"root_parent_id": "1d4fa7f5-2b09-421b-a68d-6c4b0ef8e4a6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "26ae64f4-07b9-4344-9bfd-1c22e2fcb3b3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "84bf0875-e446-43a1-98b7-22a48d895874",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "82ccbec5-eb9f-4aa3-be86-3bc8b5ba7c09",
"_parent_code": "sample string 6",
"sales_organization_id": "30fb9b69-333b-476a-9978-77042ecdc23c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5f460be5-1497-4540-9ac9-5cabb35b97ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8a5f3fed-3586-41e5-8757-9a489bf4120b",
"db_currency_id": "8d434ae5-5429-47e6-bba0-42087f1cf1cb",
"db_language_id": "4f7b5044-b2c4-40fb-81b5-4462773ea404",
"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-25T22:11:16.8592413+00:00"
},
"modified_dateutc": "2024-12-25T22:11:16.8592413+00:00"
},
"equipment_model_id": "d14802aa-6d1f-471c-a62c-0d01f0ebe959",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a86cbc35-0d28-4771-afb8-fa023da78da3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a7ddcd7c-44c1-418c-9f08-df7e29d0c8f6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "065a8583-ec0f-40ab-a034-cec5b5aadd23",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "421c1008-71ee-4556-8cac-5c3a20284d1b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5f460be5-1497-4540-9ac9-5cabb35b97ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8a5f3fed-3586-41e5-8757-9a489bf4120b",
"db_currency_id": "8d434ae5-5429-47e6-bba0-42087f1cf1cb",
"db_language_id": "4f7b5044-b2c4-40fb-81b5-4462773ea404",
"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-25T22:11:16.8592413+00:00"
},
"modified_dateutc": "2024-12-25T22:11:16.8592413+00:00"
},
"equipment_family_id": "453ef58a-4166-49f1-94a6-2b35afe13fa6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "84bf0875-e446-43a1-98b7-22a48d895874",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "82ccbec5-eb9f-4aa3-be86-3bc8b5ba7c09",
"_parent_code": "sample string 6",
"sales_organization_id": "30fb9b69-333b-476a-9978-77042ecdc23c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5f460be5-1497-4540-9ac9-5cabb35b97ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8a5f3fed-3586-41e5-8757-9a489bf4120b",
"db_currency_id": "8d434ae5-5429-47e6-bba0-42087f1cf1cb",
"db_language_id": "4f7b5044-b2c4-40fb-81b5-4462773ea404",
"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-25T22:11:16.8592413+00:00"
},
"modified_dateutc": "2024-12-25T22:11:16.8592413+00:00"
},
"date_in_production_since": "2024-12-25T22:11:16.8592413+00:00",
"date_out_of_production_since": "2024-12-25T22:11:16.8592413+00:00",
"date_end_support": "2024-12-25T22:11:16.8592413+00:00",
"sales_organization_id": "d762afe9-6fe4-4e4a-810d-3a857d35843e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5f460be5-1497-4540-9ac9-5cabb35b97ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8a5f3fed-3586-41e5-8757-9a489bf4120b",
"db_currency_id": "8d434ae5-5429-47e6-bba0-42087f1cf1cb",
"db_language_id": "4f7b5044-b2c4-40fb-81b5-4462773ea404",
"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-25T22:11:16.8592413+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-25T22:11:16.8592413+00:00"
},
"project_status_id": "8d6c60ad-7a1b-4dd4-988d-fd32e4e14ec6",
"project_status_code": "sample string 10",
"project_status": {
"id": "c9e7fde3-6d5f-438f-9976-3183914e6f2a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5d14fd89-7aa0-48b3-a776-f581ee523657",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5f460be5-1497-4540-9ac9-5cabb35b97ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8a5f3fed-3586-41e5-8757-9a489bf4120b",
"db_currency_id": "8d434ae5-5429-47e6-bba0-42087f1cf1cb",
"db_language_id": "4f7b5044-b2c4-40fb-81b5-4462773ea404",
"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-25T22:11:16.8592413+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-12-25T22:11:16.8592413+00:00"
},
"company_id": "beb95cc3-1f9b-407c-b882-9a70b1478f79",
"company_code": "sample string 12",
"db_address_id": "0f7409fc-8d84-4a75-b7c9-fb6d73b3ee79",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a0c0c9d0-599d-48f8-a4db-415771f4a3af",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "80f066f9-0969-40fc-904d-e2648ae4b837",
"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-25T22:11:16.8592413+00:00",
"date_create": "2024-12-25T22:11:16.8592413+00:00",
"date_update": "2024-12-25T22:11:16.8592413+00:00",
"updated_by_user_id": "6510732a-f0ed-4db9-ba7b-4cdda87b325a",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-12-25T22:11:16.8592413+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-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-12-25T22:11:16.8592413+00:00",
"date_last_job": "2024-12-25T22:11:16.8592413+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-12-25T22:11:16.8592413+00:00",
"modified_dateutc": "2024-12-25T22:11:16.8592413+00:00",
"is_mobile_installation": true
},
"job_type_id": "54116cc7-ef7c-4ec4-96a5-0176d8d68b0f",
"job_type_code": "sample string 7",
"job_type": {
"id": "d42f39db-1c04-417c-8c3e-bf664c1cbc1b",
"name": "sample string 2",
"sales_organization_id": "a7918d7b-9640-4f7a-9aef-6d5a80c4484e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-12-25T22:11:16.8748692+00:00",
"code": "sample string 7"
},
"job_priority_id": "ed77b229-f8ed-4073-a854-9f389a624828",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "25cbe82e-93f5-41ae-8a35-20dfbfc3c37c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e5ef748f-7a88-4b56-a101-f5235ce550e9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5f460be5-1497-4540-9ac9-5cabb35b97ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8a5f3fed-3586-41e5-8757-9a489bf4120b",
"db_currency_id": "8d434ae5-5429-47e6-bba0-42087f1cf1cb",
"db_language_id": "4f7b5044-b2c4-40fb-81b5-4462773ea404",
"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-25T22:11:16.8592413+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-12-25T22:11:16.8748692+00:00"
},
"job_status_id": "81e209a6-f2f7-4a11-a8e6-0aa1b5cf7135",
"job_status_code": "sample string 11",
"db_address_id": "99116f06-0222-44d4-8290-1bdecaa4c23a",
"contact_id": "bf45163c-2137-43fb-b573-7c7b5169188f",
"requested_by_company_id": "778bd876-2410-48e9-9efe-23bbe172254b",
"requested_by_contact_id": "fb38ca3c-e28f-45dd-8cfa-9a3aef4680ef",
"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-25T22:11:16.8748692+00:00",
"due_date": "2024-12-25T22:11:16.8748692+00:00",
"date_create": "2024-12-25T22:11:16.8748692+00:00",
"date_update": "2024-12-25T22:11:16.8748692+00:00",
"date_closed": "2024-12-25T22:11:16.8748692+00:00",
"suggested_user_id": "b7d1c426-efc5-45dc-b4a8-cfb06f4cb269",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a083a8d7-7005-4bdb-a175-c602ddc04e33",
"db_language_id": "39da98ac-1931-4a8d-8c10-b642abb807db",
"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-25T22:11:16.8748692+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "cc3e1a6f-f6c2-473c-97c9-44717fc7d437",
"sales_organization": {
"id": "5f460be5-1497-4540-9ac9-5cabb35b97ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8a5f3fed-3586-41e5-8757-9a489bf4120b",
"db_currency_id": "8d434ae5-5429-47e6-bba0-42087f1cf1cb",
"db_language_id": "4f7b5044-b2c4-40fb-81b5-4462773ea404",
"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-25T22:11:16.8592413+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "aa04f63c-288a-4bcc-bcb1-de75b398d804",
"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": "54928e55-1927-4af4-8981-d9edcb90f7c7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-12-25T22:11:16.8748692+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4dfa6205-8fe8-4ee0-9bd2-ffb54a774446"
},
"suggested_date_start": "2024-12-25T22:11:16.8748692+00:00",
"skill_id": "2f37a8f5-17fc-487a-ad27-065d6ddbcf4c",
"skill_code": "sample string 32",
"skill": {
"id": "346c3589-bfaa-40df-acc8-662085c51cb0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "86dc650a-9988-4c2a-8548-54a86bf00696",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5f460be5-1497-4540-9ac9-5cabb35b97ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8a5f3fed-3586-41e5-8757-9a489bf4120b",
"db_currency_id": "8d434ae5-5429-47e6-bba0-42087f1cf1cb",
"db_language_id": "4f7b5044-b2c4-40fb-81b5-4462773ea404",
"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-25T22:11:16.8592413+00:00"
},
"modified_dateutc": "2024-12-25T22:11:16.8748692+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c73de7ca-1f57-4d42-b93f-def06770d07e",
"date_reported_by_company": "2024-12-25T22:11:16.8748692+00:00",
"id2": 36,
"company_id": "982ea61b-b73f-423f-b282-6df59a027a09",
"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": "215883ff-342a-4cf5-b77c-10ec8d8da274",
"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-25T22:11:16.8748692+00:00"
},
"work_instruction_details_id": "2122afb3-694c-4804-b2d0-b38cffdc202a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "61ff989b-23d9-43b9-aa32-55da90c6648d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ddc2bbec-489b-493e-bc4c-2985308c8359",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-12-25T22:11:16.8748692+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": "fde6ce67-6998-46e2-8c7c-1b9c8712665f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-12-25T22:11:16.8748692+00:00"
}