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": "1b0f698c-19a3-4059-9e97-bfcee119aa3f",
"jobs_id": "9207749d-010e-4634-a26f-95718edb30ea",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "dbbdad90-324a-4428-93f1-789380b0be8d",
"_parent_id": "2f3252c1-9f10-4523-81f8-118f8fccbd3b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d477d5d2-8153-4c8d-a0c4-e996592138e6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c705cf97-bf8e-4253-a7ab-c40f4b275a85",
"_parent_id": "103a281b-aa4c-4732-8326-5f62c6db6616",
"root_parent_id": "3a9f9ce8-c2c1-4d20-8c32-9bb236bb8aa3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "188cdaf4-861f-4847-8c39-d388ecf851c7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8d7cd598-8d67-4d77-9c4a-5d2c19f5fad3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d3c13fdd-f28a-4b4d-94d0-edcc20d39e5d",
"_parent_code": "sample string 6",
"sales_organization_id": "0aebdbcb-5d9b-4859-8a85-1e45accd1b6b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "af11c1b2-b3b7-4b97-ab99-14a7f9f38dca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "23518c4f-7730-480c-9b0b-c982fdae55e8",
"db_currency_id": "d2e2f245-667a-4995-b9de-93b3d61cce15",
"db_language_id": "2e641522-3c74-43ce-a80b-2cc0c35edacb",
"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-09-03T10:14:53.5087404+00:00"
},
"modified_dateutc": "2025-09-03T10:14:53.5087404+00:00"
},
"equipment_model_id": "782fa0f2-4ed1-4683-b5e0-cf1e46bec6d0",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "2e150fd3-37ab-4a02-95b4-07f4bf293c90",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "adae8968-0abc-46a4-9a8d-3f9f4b3cd4f8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8e909c54-0bc7-4822-8d12-d40eead2e701",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6047099a-25e8-489e-afaa-6a5246e0f139",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "af11c1b2-b3b7-4b97-ab99-14a7f9f38dca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "23518c4f-7730-480c-9b0b-c982fdae55e8",
"db_currency_id": "d2e2f245-667a-4995-b9de-93b3d61cce15",
"db_language_id": "2e641522-3c74-43ce-a80b-2cc0c35edacb",
"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-09-03T10:14:53.5087404+00:00"
},
"modified_dateutc": "2025-09-03T10:14:53.5087404+00:00"
},
"equipment_family_id": "6971ce04-c79a-468f-b502-066547103f5f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8d7cd598-8d67-4d77-9c4a-5d2c19f5fad3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d3c13fdd-f28a-4b4d-94d0-edcc20d39e5d",
"_parent_code": "sample string 6",
"sales_organization_id": "0aebdbcb-5d9b-4859-8a85-1e45accd1b6b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "af11c1b2-b3b7-4b97-ab99-14a7f9f38dca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "23518c4f-7730-480c-9b0b-c982fdae55e8",
"db_currency_id": "d2e2f245-667a-4995-b9de-93b3d61cce15",
"db_language_id": "2e641522-3c74-43ce-a80b-2cc0c35edacb",
"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-09-03T10:14:53.5087404+00:00"
},
"modified_dateutc": "2025-09-03T10:14:53.5087404+00:00"
},
"date_in_production_since": "2025-09-03T10:14:53.5087404+00:00",
"date_out_of_production_since": "2025-09-03T10:14:53.5087404+00:00",
"date_end_support": "2025-09-03T10:14:53.5087404+00:00",
"sales_organization_id": "fddabbbf-c0f1-495c-8ba2-4528de3e7cf7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "af11c1b2-b3b7-4b97-ab99-14a7f9f38dca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "23518c4f-7730-480c-9b0b-c982fdae55e8",
"db_currency_id": "d2e2f245-667a-4995-b9de-93b3d61cce15",
"db_language_id": "2e641522-3c74-43ce-a80b-2cc0c35edacb",
"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-09-03T10:14:53.5087404+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-09-03T10:14:53.5087404+00:00"
},
"project_status_id": "ae102c37-e9e7-481d-bfc8-e176289f47d3",
"project_status_code": "sample string 10",
"project_status": {
"id": "e6dd8a94-b3dd-478b-acaf-46dcdcc62f3a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5b8a6bb9-b41c-4618-88d3-fef1b040470e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "af11c1b2-b3b7-4b97-ab99-14a7f9f38dca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "23518c4f-7730-480c-9b0b-c982fdae55e8",
"db_currency_id": "d2e2f245-667a-4995-b9de-93b3d61cce15",
"db_language_id": "2e641522-3c74-43ce-a80b-2cc0c35edacb",
"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-09-03T10:14:53.5087404+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-03T10:14:53.5087404+00:00"
},
"company_id": "9c73b224-c277-445e-9687-c9c95dc8dfbe",
"company_code": "sample string 12",
"db_address_id": "a7228fb4-2e44-4ad5-b5e2-d6e3a1c01137",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6c0c2de5-5a0a-4e33-96dd-2a8cc2785a1e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ed82393d-3134-4116-8f36-0e890f89aedf",
"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-09-03T10:14:53.5087404+00:00",
"date_create": "2025-09-03T10:14:53.5087404+00:00",
"date_update": "2025-09-03T10:14:53.5087404+00:00",
"updated_by_user_id": "eab28a36-1dfa-4692-96e3-135b5169820d",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-09-03T10:14:53.5087404+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-09-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-09-03T10:14:53.5087404+00:00",
"date_last_job": "2025-09-03T10:14:53.5087404+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-09-03T10:14:53.5087404+00:00",
"modified_dateutc": "2025-09-03T10:14:53.5087404+00:00",
"is_mobile_installation": true
},
"job_type_id": "1d83c6fc-a500-44e6-bb50-f651319ae6a8",
"job_type_code": "sample string 7",
"job_type": {
"id": "89b90cd8-f82b-4990-9c15-aba579e2f744",
"name": "sample string 2",
"sales_organization_id": "6667ad96-b202-4499-b207-b5869fe71405",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-09-03T10:14:53.5087404+00:00",
"code": "sample string 7"
},
"job_priority_id": "308f157b-f1f7-49d3-8edf-cf260bec5765",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "294e93f4-75df-411b-99a4-30941bc62588",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6f228d92-207e-455f-8f84-75b1ee90d3d1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "af11c1b2-b3b7-4b97-ab99-14a7f9f38dca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "23518c4f-7730-480c-9b0b-c982fdae55e8",
"db_currency_id": "d2e2f245-667a-4995-b9de-93b3d61cce15",
"db_language_id": "2e641522-3c74-43ce-a80b-2cc0c35edacb",
"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-09-03T10:14:53.5087404+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-03T10:14:53.5087404+00:00"
},
"job_status_id": "7ed92fad-1dea-4598-92e7-fca59e623c51",
"job_status_code": "sample string 11",
"db_address_id": "a8f6dd4a-1ea4-4c76-87b8-663f2a7277c3",
"contact_id": "a5580d4b-7f80-4940-b626-cb033de2035e",
"requested_by_company_id": "409d8609-83f6-4e2e-8921-b02ab3dce5f2",
"requested_by_contact_id": "dce0e726-e908-4c26-b042-39581d010ea6",
"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-09-03T10:14:53.5087404+00:00",
"due_date": "2025-09-03T10:14:53.5087404+00:00",
"date_create": "2025-09-03T10:14:53.5087404+00:00",
"date_update": "2025-09-03T10:14:53.5087404+00:00",
"date_closed": "2025-09-03T10:14:53.5087404+00:00",
"suggested_user_id": "6872312b-5442-4919-ba34-9e72789597a2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "569edf72-6bd0-48b7-b1a5-be05869898d1",
"db_language_id": "a6458752-3a12-42cf-93ab-7465f21510e1",
"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-09-03T10:14:53.5087404+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5857a70c-c003-4e41-b4a9-940033b83be7",
"sales_organization": {
"id": "af11c1b2-b3b7-4b97-ab99-14a7f9f38dca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "23518c4f-7730-480c-9b0b-c982fdae55e8",
"db_currency_id": "d2e2f245-667a-4995-b9de-93b3d61cce15",
"db_language_id": "2e641522-3c74-43ce-a80b-2cc0c35edacb",
"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-09-03T10:14:53.5087404+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c61235c8-a348-4e91-a1e8-980536457e7f",
"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": "6729dca1-08cd-4065-97f8-42a664044d79",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-09-03T10:14:53.5087404+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "13bc2e6f-50a1-4850-a679-ebd1f95d7738"
},
"suggested_date_start": "2025-09-03T10:14:53.5087404+00:00",
"skill_id": "0df57af7-76cc-49ca-8fbe-0c85efc8b767",
"skill_code": "sample string 32",
"skill": {
"id": "005f9ef3-79d8-4c98-ba83-a8a113999ced",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3bdc85e5-c617-4bee-b4e4-9fd2d34cfcf8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "af11c1b2-b3b7-4b97-ab99-14a7f9f38dca",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "23518c4f-7730-480c-9b0b-c982fdae55e8",
"db_currency_id": "d2e2f245-667a-4995-b9de-93b3d61cce15",
"db_language_id": "2e641522-3c74-43ce-a80b-2cc0c35edacb",
"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-09-03T10:14:53.5087404+00:00"
},
"modified_dateutc": "2025-09-03T10:14:53.5087404+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8d042418-66c7-45c9-95c4-dfbc6a765838",
"date_reported_by_company": "2025-09-03T10:14:53.5087404+00:00",
"id2": 36,
"company_id": "178582d0-45a9-482b-9e7d-efe74ba8c300",
"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": "ce72d8f9-c773-479a-ab6c-470e7dfb9c28",
"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-09-03T10:14:53.5087404+00:00"
},
"work_instruction_details_id": "a4f5b428-6dbc-4e2f-9088-997e8478052b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "dbe638c2-e3bd-4deb-b1ef-0f9043fbfcd5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "30401343-3055-4437-8e5e-a47628fca2a8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-09-03T10:14:53.5087404+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": "ffb5e42a-9bbb-47a5-aa94-50046e27e400",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-09-03T10:14:53.5087404+00:00"
}