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": "95cd4a64-6c82-45bd-80d0-090904714aaa",
"jobs_id": "2713ed17-3e44-4222-9d4c-adea0a62adf5",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "281b70e2-bb08-47d6-b546-ff9bcdea6372",
"_parent_id": "04eafebd-5f5a-4116-b15b-99910a71b8e0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1d553adc-a792-49f1-a509-a9a3f1f18f2d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1e5f4e73-75f9-4b53-9c70-204c5f77173b",
"_parent_id": "17171990-c126-489f-9f0d-e491b47a6810",
"root_parent_id": "6ea6375b-0623-428f-8b4d-9d3318736a5f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8b4858e8-a49a-4da0-8a5b-cebb61d15439",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5638ed7d-f452-4386-ac98-489ba529608c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2ea22057-23e0-41d8-9b7d-458a9a257218",
"_parent_code": "sample string 6",
"sales_organization_id": "93d3e4a9-a302-4059-8bdb-951a1d42d8e2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "55765f8b-5316-4eba-a500-438d081d2fb7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4932132d-6082-4a49-beba-3362bffb643c",
"db_currency_id": "27a69147-99f9-4ebe-b5e3-5d42a5b6de8c",
"db_language_id": "703b85f2-285c-4557-8c76-1dcccc3cdf65",
"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": "2026-05-21T13:24:48.6105488+00:00"
},
"modified_dateutc": "2026-05-21T13:24:48.6105488+00:00"
},
"equipment_model_id": "f56aeb1c-619e-469f-9b3c-3903616fc2ba",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "643eca65-64ab-44f5-bb0c-f7e62018d07d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7f0be04a-4458-45ef-8ad7-3977ae06149b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c60c51c9-af22-4037-90b3-a996d5092228",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c9bad568-3b89-474d-be80-a2b32cf774e3",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "55765f8b-5316-4eba-a500-438d081d2fb7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4932132d-6082-4a49-beba-3362bffb643c",
"db_currency_id": "27a69147-99f9-4ebe-b5e3-5d42a5b6de8c",
"db_language_id": "703b85f2-285c-4557-8c76-1dcccc3cdf65",
"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": "2026-05-21T13:24:48.6105488+00:00"
},
"modified_dateutc": "2026-05-21T13:24:48.6105488+00:00"
},
"equipment_family_id": "147842a5-ba37-44ae-a11b-2598521c0a71",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5638ed7d-f452-4386-ac98-489ba529608c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2ea22057-23e0-41d8-9b7d-458a9a257218",
"_parent_code": "sample string 6",
"sales_organization_id": "93d3e4a9-a302-4059-8bdb-951a1d42d8e2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "55765f8b-5316-4eba-a500-438d081d2fb7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4932132d-6082-4a49-beba-3362bffb643c",
"db_currency_id": "27a69147-99f9-4ebe-b5e3-5d42a5b6de8c",
"db_language_id": "703b85f2-285c-4557-8c76-1dcccc3cdf65",
"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": "2026-05-21T13:24:48.6105488+00:00"
},
"modified_dateutc": "2026-05-21T13:24:48.6105488+00:00"
},
"date_in_production_since": "2026-05-21T13:24:48.6105488+00:00",
"date_out_of_production_since": "2026-05-21T13:24:48.6105488+00:00",
"date_end_support": "2026-05-21T13:24:48.6105488+00:00",
"sales_organization_id": "689a3fbc-de82-423a-beed-5098baeea6e6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "55765f8b-5316-4eba-a500-438d081d2fb7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4932132d-6082-4a49-beba-3362bffb643c",
"db_currency_id": "27a69147-99f9-4ebe-b5e3-5d42a5b6de8c",
"db_language_id": "703b85f2-285c-4557-8c76-1dcccc3cdf65",
"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": "2026-05-21T13:24:48.6105488+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": "2026-05-21T13:24:48.6105488+00:00"
},
"project_status_id": "3b765ad6-ee04-47cf-bd59-fa645446146e",
"project_status_code": "sample string 10",
"project_status": {
"id": "2ce4bb0a-ddcc-4d2c-8e82-4aaaf2f9d562",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6f07fa48-bc27-486a-8043-674bfdcde97f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "55765f8b-5316-4eba-a500-438d081d2fb7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4932132d-6082-4a49-beba-3362bffb643c",
"db_currency_id": "27a69147-99f9-4ebe-b5e3-5d42a5b6de8c",
"db_language_id": "703b85f2-285c-4557-8c76-1dcccc3cdf65",
"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": "2026-05-21T13:24:48.6105488+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-21T13:24:48.6105488+00:00"
},
"company_id": "eb64fe7c-a59c-4f55-8c1f-69a680ecf0c5",
"company_code": "sample string 12",
"db_address_id": "adb0a6e7-3944-446f-af89-025b9d9a3ee2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7232016f-9b04-44ad-a31d-ba549b5e2232",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a5fa0b10-a582-4b1d-b8a5-03a99416f15d",
"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": "2026-05-21T13:24:48.6105488+00:00",
"date_create": "2026-05-21T13:24:48.6105488+00:00",
"date_update": "2026-05-21T13:24:48.6105488+00:00",
"updated_by_user_id": "7cdf598f-7928-4bf0-9338-a185ddd2ad1a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-21T13:24:48.6105488+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": "2026-05-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-21T13:24:48.6105488+00:00",
"date_last_job": "2026-05-21T13:24:48.6105488+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-21T13:24:48.6105488+00:00",
"modified_dateutc": "2026-05-21T13:24:48.6105488+00:00",
"is_mobile_installation": true
},
"job_type_id": "e4b34fac-c7c5-40a3-b254-cbbb6607793d",
"job_type_code": "sample string 7",
"job_type": {
"id": "065dd831-44bb-47a1-b200-404781f2ec7b",
"name": "sample string 2",
"sales_organization_id": "6296fea9-7568-43f3-85e1-42cc1bf537e9",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-21T13:24:48.6105488+00:00",
"code": "sample string 7"
},
"job_priority_id": "b6f107c3-3c82-46e7-b0b7-77d5b58fb1b7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7c502879-45f4-4041-84b5-71f3826f890e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "25f4568b-09a1-4e70-848c-2f9ad9157e64",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "55765f8b-5316-4eba-a500-438d081d2fb7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4932132d-6082-4a49-beba-3362bffb643c",
"db_currency_id": "27a69147-99f9-4ebe-b5e3-5d42a5b6de8c",
"db_language_id": "703b85f2-285c-4557-8c76-1dcccc3cdf65",
"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": "2026-05-21T13:24:48.6105488+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-21T13:24:48.6105488+00:00"
},
"job_status_id": "ef39f76d-adf3-4cf1-a8c5-142959cadf74",
"job_status_code": "sample string 11",
"db_address_id": "5bfd4921-9dee-4051-aa3d-a8a89cc95759",
"contact_id": "1d9212ac-2938-4f54-956e-214a1ae377ca",
"requested_by_company_id": "c26b7147-1a04-4d0b-8a0b-a1382174ec95",
"requested_by_contact_id": "8529a0fa-226f-43b1-ad7f-44100eb9eaaf",
"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": "2026-05-21T13:24:48.6105488+00:00",
"due_date": "2026-05-21T13:24:48.6105488+00:00",
"date_create": "2026-05-21T13:24:48.6105488+00:00",
"date_update": "2026-05-21T13:24:48.6261711+00:00",
"date_closed": "2026-05-21T13:24:48.6261711+00:00",
"suggested_user_id": "20d4ef45-854e-4ab3-b684-83c14118edb4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2e83434c-54a4-4edf-bf6f-bac89b8cf876",
"db_language_id": "c322e150-7ff5-406d-8582-ee73f074d08b",
"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": "2026-05-21T13:24:48.6261711+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "109cb16f-5dd2-4458-9499-3af1081d059f",
"sales_organization": {
"id": "55765f8b-5316-4eba-a500-438d081d2fb7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4932132d-6082-4a49-beba-3362bffb643c",
"db_currency_id": "27a69147-99f9-4ebe-b5e3-5d42a5b6de8c",
"db_language_id": "703b85f2-285c-4557-8c76-1dcccc3cdf65",
"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": "2026-05-21T13:24:48.6105488+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8dc76146-c93d-4ab1-b2e3-d9e212d987a5",
"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": "724b04b6-6f4f-4035-8bcc-22dbdf4e8cee",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-21T13:24:48.6261711+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "acfd0fd7-1c09-45ba-a18b-bc954872c924"
},
"suggested_date_start": "2026-05-21T13:24:48.6261711+00:00",
"skill_id": "34559b75-cd68-4d7f-b2e8-59c36b8682d4",
"skill_code": "sample string 32",
"skill": {
"id": "6b1791f6-bf29-4f57-a403-204a278b9592",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6be9344b-d25a-48ed-a224-ee4b10945e17",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "55765f8b-5316-4eba-a500-438d081d2fb7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4932132d-6082-4a49-beba-3362bffb643c",
"db_currency_id": "27a69147-99f9-4ebe-b5e3-5d42a5b6de8c",
"db_language_id": "703b85f2-285c-4557-8c76-1dcccc3cdf65",
"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": "2026-05-21T13:24:48.6105488+00:00"
},
"modified_dateutc": "2026-05-21T13:24:48.6261711+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4e01ddba-e009-4a7c-bdb9-2387f1353227",
"date_reported_by_company": "2026-05-21T13:24:48.6261711+00:00",
"id2": 36,
"company_id": "d7b5415a-6415-453e-8ddd-0baca8b89b33",
"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": "4304f8f8-afb3-459a-b971-64a25e52ff1d",
"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": "2026-05-21T13:24:48.6261711+00:00"
},
"work_instruction_details_id": "95135299-8010-436a-ac5e-4701a7c177a5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e178a906-8ddb-4a69-b2bb-8c0660755a83",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e36a0999-ea78-40bc-9722-6919a0019a88",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-21T13:24:48.6261711+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": "03bba5a7-123d-4877-9829-f6add93371fc",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-21T13:24:48.6261711+00:00"
}