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": "76f35456-f046-4672-a36d-cbae3dd53cf4",
"jobs_id": "468ab664-f30d-41bc-8e7d-f848aeb3c2d3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "eed832e0-90f3-4d85-867f-8acf3b6e1bd6",
"_parent_id": "09aa3dc4-96e2-4c15-9719-00b97326cbc4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4a81cc11-9ccd-4056-a836-3a7577e4ef0e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2384f353-f0f1-429d-b37e-48fad3395ed0",
"_parent_id": "da73e660-13fc-4892-87ef-54380bb746f0",
"root_parent_id": "483f24bb-0d76-452b-be25-45e48d2b4f2b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b56de6c5-924d-4b54-8c33-496748afd129",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "aa986fe3-f5b2-40ea-b0b2-c14011a57286",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6729478b-54d9-4a91-8cbc-b9a1460e378a",
"_parent_code": "sample string 6",
"sales_organization_id": "8b513388-201d-4fcb-b10a-45edfca2b8ab",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c55e601b-addf-46e4-96d4-448c2ae3ea18",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0d74e69b-7e9d-42f0-82d3-ad7193673d88",
"db_currency_id": "5ca29ac8-9ad3-4045-848a-6e38e242face",
"db_language_id": "a365555e-a902-4293-8ba7-47a37a47104d",
"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-05-18T01:17:41.0123762+00:00"
},
"modified_dateutc": "2025-05-18T01:17:41.0123762+00:00"
},
"equipment_model_id": "571f1286-3bcb-4b45-93c6-d6c5b5f227d2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "39db8b66-5d44-4f6e-a37b-454ddec24464",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b8087305-f6a9-4d9a-bdfe-6060f97f5725",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4334525e-0bec-486c-994b-5accb93a1b80",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "83c7a133-e01d-4ccd-be69-f7d7c6317630",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c55e601b-addf-46e4-96d4-448c2ae3ea18",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0d74e69b-7e9d-42f0-82d3-ad7193673d88",
"db_currency_id": "5ca29ac8-9ad3-4045-848a-6e38e242face",
"db_language_id": "a365555e-a902-4293-8ba7-47a37a47104d",
"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-05-18T01:17:41.0123762+00:00"
},
"modified_dateutc": "2025-05-18T01:17:41.0123762+00:00"
},
"equipment_family_id": "4b15c812-66bf-4a6a-b425-45721bbefcab",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "aa986fe3-f5b2-40ea-b0b2-c14011a57286",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6729478b-54d9-4a91-8cbc-b9a1460e378a",
"_parent_code": "sample string 6",
"sales_organization_id": "8b513388-201d-4fcb-b10a-45edfca2b8ab",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c55e601b-addf-46e4-96d4-448c2ae3ea18",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0d74e69b-7e9d-42f0-82d3-ad7193673d88",
"db_currency_id": "5ca29ac8-9ad3-4045-848a-6e38e242face",
"db_language_id": "a365555e-a902-4293-8ba7-47a37a47104d",
"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-05-18T01:17:41.0123762+00:00"
},
"modified_dateutc": "2025-05-18T01:17:41.0123762+00:00"
},
"date_in_production_since": "2025-05-18T01:17:41.0123762+00:00",
"date_out_of_production_since": "2025-05-18T01:17:41.0123762+00:00",
"date_end_support": "2025-05-18T01:17:41.0123762+00:00",
"sales_organization_id": "7f338ccd-cd4e-45c0-a273-bbac91806196",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c55e601b-addf-46e4-96d4-448c2ae3ea18",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0d74e69b-7e9d-42f0-82d3-ad7193673d88",
"db_currency_id": "5ca29ac8-9ad3-4045-848a-6e38e242face",
"db_language_id": "a365555e-a902-4293-8ba7-47a37a47104d",
"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-05-18T01:17:41.0123762+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-05-18T01:17:41.0123762+00:00"
},
"project_status_id": "8f75142e-f0d7-4917-99db-64e9dbf152bc",
"project_status_code": "sample string 10",
"project_status": {
"id": "31aa8504-f159-4263-be05-8ef311a4ce1b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "22cb4001-e905-4347-b65a-4fc992dcd3ab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c55e601b-addf-46e4-96d4-448c2ae3ea18",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0d74e69b-7e9d-42f0-82d3-ad7193673d88",
"db_currency_id": "5ca29ac8-9ad3-4045-848a-6e38e242face",
"db_language_id": "a365555e-a902-4293-8ba7-47a37a47104d",
"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-05-18T01:17:41.0123762+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-18T01:17:41.0123762+00:00"
},
"company_id": "4fc2f451-a1c3-4797-a226-58a07006bbef",
"company_code": "sample string 12",
"db_address_id": "ba2b366d-a7f3-4f62-87f1-0280a9e8d7fa",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "acee5187-8e46-49e4-9b58-8885d4a9da9f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "97171c49-d97c-4a04-9829-d2865ef53ee5",
"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-05-18T01:17:41.0123762+00:00",
"date_create": "2025-05-18T01:17:41.0123762+00:00",
"date_update": "2025-05-18T01:17:41.0123762+00:00",
"updated_by_user_id": "9ef13575-fd4d-46d0-b6fb-fbd318b5aa8c",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-05-18T01:17:41.0123762+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-05-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-05-18T01:17:41.0123762+00:00",
"date_last_job": "2025-05-18T01:17:41.0123762+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-05-18T01:17:41.0123762+00:00",
"modified_dateutc": "2025-05-18T01:17:41.0123762+00:00",
"is_mobile_installation": true
},
"job_type_id": "ce1e12a8-48cc-4e8c-b3cb-84b4089f6950",
"job_type_code": "sample string 7",
"job_type": {
"id": "fcfa5956-8df5-4e71-8727-e6b6c166c8d2",
"name": "sample string 2",
"sales_organization_id": "ba606516-9ca3-4759-8e3a-fc2f9d361d36",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-05-18T01:17:41.0123762+00:00",
"code": "sample string 7"
},
"job_priority_id": "6b6d7030-fe6c-40de-b2a0-8d3ffd572864",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e09bdcea-753f-4aa8-b33a-a90b2c6f6939",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6b282c54-02a8-495c-a9c8-e9fddd112565",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c55e601b-addf-46e4-96d4-448c2ae3ea18",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0d74e69b-7e9d-42f0-82d3-ad7193673d88",
"db_currency_id": "5ca29ac8-9ad3-4045-848a-6e38e242face",
"db_language_id": "a365555e-a902-4293-8ba7-47a37a47104d",
"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-05-18T01:17:41.0123762+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-18T01:17:41.0123762+00:00"
},
"job_status_id": "0dc2d58d-b270-4fc5-8128-6ecd06a294f2",
"job_status_code": "sample string 11",
"db_address_id": "d98d09cd-e313-4a2c-915f-ef34ef79051b",
"contact_id": "1fd14585-0d47-4643-93ce-8994dca1faf4",
"requested_by_company_id": "55d9bab7-66e7-4143-aae5-8091a1a0324c",
"requested_by_contact_id": "46491a27-0214-40e3-94f6-e0f010ee6825",
"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-05-18T01:17:41.0123762+00:00",
"due_date": "2025-05-18T01:17:41.0123762+00:00",
"date_create": "2025-05-18T01:17:41.0123762+00:00",
"date_update": "2025-05-18T01:17:41.0123762+00:00",
"date_closed": "2025-05-18T01:17:41.0123762+00:00",
"suggested_user_id": "b9f2a1c3-3394-48fc-b927-c936b1e61035",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "aab5aa66-8abf-4b8d-830c-122a100dc82d",
"db_language_id": "869b1738-6bfd-4dd0-8459-78075d78863b",
"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-05-18T01:17:41.0123762+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "72573398-5615-4cec-9660-a3b2992ea7e5",
"sales_organization": {
"id": "c55e601b-addf-46e4-96d4-448c2ae3ea18",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0d74e69b-7e9d-42f0-82d3-ad7193673d88",
"db_currency_id": "5ca29ac8-9ad3-4045-848a-6e38e242face",
"db_language_id": "a365555e-a902-4293-8ba7-47a37a47104d",
"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-05-18T01:17:41.0123762+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ff54bbe9-9589-46d7-a0eb-a80b2c76f7a0",
"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": "be4c5285-ba74-405e-a0ff-fb29d377bd9a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-05-18T01:17:41.0123762+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "62af4d05-2cb6-460c-9eb8-ee14373bc9be"
},
"suggested_date_start": "2025-05-18T01:17:41.0123762+00:00",
"skill_id": "313c8bbc-72a4-496e-99cf-5e2b3e62f26d",
"skill_code": "sample string 32",
"skill": {
"id": "3ebefc20-efc3-4b3b-860a-fa0bbe97e5d3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8fb98952-03e2-4db6-a178-478b3ea75197",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c55e601b-addf-46e4-96d4-448c2ae3ea18",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0d74e69b-7e9d-42f0-82d3-ad7193673d88",
"db_currency_id": "5ca29ac8-9ad3-4045-848a-6e38e242face",
"db_language_id": "a365555e-a902-4293-8ba7-47a37a47104d",
"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-05-18T01:17:41.0123762+00:00"
},
"modified_dateutc": "2025-05-18T01:17:41.0123762+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d98bbbe2-07bd-4913-81ff-3884ebe437e0",
"date_reported_by_company": "2025-05-18T01:17:41.0123762+00:00",
"id2": 36,
"company_id": "11a39cca-3ea9-4e18-977f-6fee5d998b27",
"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": "e6ee8ad0-d782-47eb-a8d7-ca23067290da",
"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-05-18T01:17:41.0123762+00:00"
},
"work_instruction_details_id": "91c5cfa4-296e-4b5d-bfe3-d9e454427a39",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "28dbf134-ddcb-46fc-9f60-141ad2e9dbef",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fc9e4b05-f628-4fe5-80c9-4406913ec82c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-05-18T01:17:41.0123762+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": "5d02cc44-e5af-4293-aeca-67f5cd235808",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-05-18T01:17:41.0123762+00:00"
}