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": "edc9a525-1d7a-4ca3-9f26-628fa4978ad4",
"jobs_id": "f748701a-cbed-43ef-8f8e-29c43efce443",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "41ad97f4-8842-42c0-b96f-4a09bd587310",
"_parent_id": "159f10ad-8742-4f1a-82f5-05656163a0f2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e4bab960-18d3-4d05-bbba-88c5246c44e2",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e61fddf8-ca1c-465b-9282-239950a5da99",
"_parent_id": "b18f31a0-6325-4585-a406-4d61778efeb8",
"root_parent_id": "da2b9bc9-7638-4f9a-8188-7fd4bd8d69da",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "215fb838-3f51-4acd-87e2-4f24bbed6291",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "26d25a6b-ca18-4493-8058-89d0cd1988f0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "468d12b6-86cd-4cc7-b991-ab0c0f571f49",
"_parent_code": "sample string 6",
"sales_organization_id": "988bf19d-1093-4b9d-85ac-4d38f20eb275",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "873fb121-a0a2-48e9-8a49-f8bd7ab4529e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "392a518b-7bd5-45d8-9e4c-538aa54a2a38",
"db_currency_id": "fd73061a-eab9-4a0c-9ddd-eed323b6cb85",
"db_language_id": "b5a7f4fe-502e-4596-a176-1668a432f162",
"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-04-25T04:50:40.1504143+00:00"
},
"modified_dateutc": "2025-04-25T04:50:40.1504143+00:00"
},
"equipment_model_id": "96ec6317-f55e-4fe3-99fb-b942c0632ef2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "338ff232-69ad-4bde-962c-beb3bb8044fe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f25bc2ba-d2f1-459b-809a-7c7dcb197db3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "33713237-a9bd-47f3-bf05-c2272061a527",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "96748591-08ba-4f6e-ad5c-f3442c9ed483",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "873fb121-a0a2-48e9-8a49-f8bd7ab4529e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "392a518b-7bd5-45d8-9e4c-538aa54a2a38",
"db_currency_id": "fd73061a-eab9-4a0c-9ddd-eed323b6cb85",
"db_language_id": "b5a7f4fe-502e-4596-a176-1668a432f162",
"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-04-25T04:50:40.1504143+00:00"
},
"modified_dateutc": "2025-04-25T04:50:40.1504143+00:00"
},
"equipment_family_id": "beebec92-3771-4578-ab93-54d05dda228a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "26d25a6b-ca18-4493-8058-89d0cd1988f0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "468d12b6-86cd-4cc7-b991-ab0c0f571f49",
"_parent_code": "sample string 6",
"sales_organization_id": "988bf19d-1093-4b9d-85ac-4d38f20eb275",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "873fb121-a0a2-48e9-8a49-f8bd7ab4529e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "392a518b-7bd5-45d8-9e4c-538aa54a2a38",
"db_currency_id": "fd73061a-eab9-4a0c-9ddd-eed323b6cb85",
"db_language_id": "b5a7f4fe-502e-4596-a176-1668a432f162",
"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-04-25T04:50:40.1504143+00:00"
},
"modified_dateutc": "2025-04-25T04:50:40.1504143+00:00"
},
"date_in_production_since": "2025-04-25T04:50:40.1504143+00:00",
"date_out_of_production_since": "2025-04-25T04:50:40.1504143+00:00",
"date_end_support": "2025-04-25T04:50:40.1504143+00:00",
"sales_organization_id": "bdbcdae9-e2d9-496c-b1c2-6f4cb7050fc3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "873fb121-a0a2-48e9-8a49-f8bd7ab4529e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "392a518b-7bd5-45d8-9e4c-538aa54a2a38",
"db_currency_id": "fd73061a-eab9-4a0c-9ddd-eed323b6cb85",
"db_language_id": "b5a7f4fe-502e-4596-a176-1668a432f162",
"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-04-25T04:50:40.1504143+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-04-25T04:50:40.1504143+00:00"
},
"project_status_id": "0f8b6ede-a178-487d-9b46-66f8c05b5cda",
"project_status_code": "sample string 10",
"project_status": {
"id": "34162557-e14b-44d7-9c46-d4e0ecdcf016",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8037af06-ef1e-4dd2-bd50-dd4e7f1f6f34",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "873fb121-a0a2-48e9-8a49-f8bd7ab4529e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "392a518b-7bd5-45d8-9e4c-538aa54a2a38",
"db_currency_id": "fd73061a-eab9-4a0c-9ddd-eed323b6cb85",
"db_language_id": "b5a7f4fe-502e-4596-a176-1668a432f162",
"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-04-25T04:50:40.1504143+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-04-25T04:50:40.1504143+00:00"
},
"company_id": "30408e9b-088e-42c9-a276-a1d9df64cec8",
"company_code": "sample string 12",
"db_address_id": "3670b825-7569-40e0-bb43-a5ed64466017",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d54d874f-c503-423a-ba64-01a1223ce1ca",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a2cd7793-ad23-4819-bb48-5f051914f5ec",
"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-04-25T04:50:40.1504143+00:00",
"date_create": "2025-04-25T04:50:40.1504143+00:00",
"date_update": "2025-04-25T04:50:40.1504143+00:00",
"updated_by_user_id": "62e43afd-b05e-4d6d-b554-b264f4e0d0ff",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-04-25T04:50:40.1504143+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-04-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-04-25T04:50:40.1504143+00:00",
"date_last_job": "2025-04-25T04:50:40.1504143+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-04-25T04:50:40.1504143+00:00",
"modified_dateutc": "2025-04-25T04:50:40.1504143+00:00",
"is_mobile_installation": true
},
"job_type_id": "881055ac-c1f6-4a2c-bfc2-f2b7b564e1f4",
"job_type_code": "sample string 7",
"job_type": {
"id": "084d99d5-e909-4625-b572-f801350d401f",
"name": "sample string 2",
"sales_organization_id": "87570c03-9aed-49b9-aa5a-84aed478952b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-04-25T04:50:40.1504143+00:00",
"code": "sample string 7"
},
"job_priority_id": "e60f6d98-9414-4075-bedf-7033112f614a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bcf2eb27-de89-411e-8292-4e541d44f948",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "225b9d92-206a-470d-a075-340d02298617",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "873fb121-a0a2-48e9-8a49-f8bd7ab4529e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "392a518b-7bd5-45d8-9e4c-538aa54a2a38",
"db_currency_id": "fd73061a-eab9-4a0c-9ddd-eed323b6cb85",
"db_language_id": "b5a7f4fe-502e-4596-a176-1668a432f162",
"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-04-25T04:50:40.1504143+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-04-25T04:50:40.1504143+00:00"
},
"job_status_id": "43515e8a-b3ab-4539-82ec-50ec45ee3732",
"job_status_code": "sample string 11",
"db_address_id": "211d4d2e-218f-488f-a003-9394c161fe0a",
"contact_id": "27a07024-19e7-4448-aaf5-56e41e02ece8",
"requested_by_company_id": "d2801980-ea21-4b31-99bf-2c4645ce2a70",
"requested_by_contact_id": "7c3bb3ff-4130-432c-9755-b61af4feb2dc",
"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-04-25T04:50:40.1504143+00:00",
"due_date": "2025-04-25T04:50:40.1504143+00:00",
"date_create": "2025-04-25T04:50:40.1504143+00:00",
"date_update": "2025-04-25T04:50:40.1504143+00:00",
"date_closed": "2025-04-25T04:50:40.1504143+00:00",
"suggested_user_id": "a495cecc-0ab0-4b63-aaa3-c0816b607bc5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "febae3e9-6f9f-424a-aaf0-1ff87cbb8e4f",
"db_language_id": "dfa72650-1524-49b2-8d24-952687b9eeee",
"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-04-25T04:50:40.1504143+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f29b1e72-65a9-4bb6-a231-a422311712f1",
"sales_organization": {
"id": "873fb121-a0a2-48e9-8a49-f8bd7ab4529e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "392a518b-7bd5-45d8-9e4c-538aa54a2a38",
"db_currency_id": "fd73061a-eab9-4a0c-9ddd-eed323b6cb85",
"db_language_id": "b5a7f4fe-502e-4596-a176-1668a432f162",
"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-04-25T04:50:40.1504143+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c6829da0-be7c-46b9-8ae9-6a6f45202e7c",
"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": "66f66cd2-fa6a-479d-8769-19d3eaa88777",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-04-25T04:50:40.1504143+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5db38d85-508e-414c-bd0b-8c5a63ab5acd"
},
"suggested_date_start": "2025-04-25T04:50:40.1504143+00:00",
"skill_id": "3944a04c-1ebb-4152-b400-d5b2019aa1c1",
"skill_code": "sample string 32",
"skill": {
"id": "85b1cd73-ba19-42ab-bb6e-b82b25c4b934",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4f4de380-7e24-46df-a06d-37ba7f3f123d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "873fb121-a0a2-48e9-8a49-f8bd7ab4529e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "392a518b-7bd5-45d8-9e4c-538aa54a2a38",
"db_currency_id": "fd73061a-eab9-4a0c-9ddd-eed323b6cb85",
"db_language_id": "b5a7f4fe-502e-4596-a176-1668a432f162",
"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-04-25T04:50:40.1504143+00:00"
},
"modified_dateutc": "2025-04-25T04:50:40.1504143+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0a1851ca-334d-4feb-8ad0-d75ba7528932",
"date_reported_by_company": "2025-04-25T04:50:40.1504143+00:00",
"id2": 36,
"company_id": "bcf17aef-3634-42b0-a15a-851aa5a6313e",
"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": "351adb4e-a805-4908-a3e2-4d5bc520223c",
"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-04-25T04:50:40.1504143+00:00"
},
"work_instruction_details_id": "bc5cae72-b096-43cd-9b12-c4f2e6d01d1b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3aaf75bb-aeda-4e3c-b30f-8e259dd9bf48",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0ec73ee4-25ef-4ded-9c17-c01f90b23ddd",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-04-25T04:50:40.1504143+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": "8df349e0-95c8-442c-9b01-bbfea46dff8b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-04-25T04:50:40.1504143+00:00"
}