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": "5da37bb7-ab24-4a72-a309-b3354bbba75e",
"jobs_id": "04e7edca-c70c-4b7a-8e3f-55a750ed6711",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6b94d372-ce93-43dd-8913-29051b856924",
"_parent_id": "21e231e5-e045-4128-a728-912e2e9397e6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1c9e3f71-adcd-4fd7-9019-a0bc2c243203",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f59d013d-89ae-4344-b8f1-ab4e34af5b43",
"_parent_id": "89af0839-c163-41f3-b932-be512ee63e18",
"root_parent_id": "c9f944ee-fe8f-4c75-94dc-39d2d79df08f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1187dc6b-9556-4871-816b-f1376c046baa",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "cf0e0fc6-d901-42cb-9242-1c18c58b913c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7bdab814-4dfb-477c-80ab-4b483b027b75",
"_parent_code": "sample string 6",
"sales_organization_id": "fd45f539-10ab-42c2-8510-a31b08a59cb5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "34888275-a199-4312-a5ab-6631eba38ef7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0af47eba-c3ad-4ae0-85ab-b8a5664a6eb7",
"db_currency_id": "8f72f7f4-483c-4647-9ce0-1ec91d1e8be5",
"db_language_id": "901ff218-e7f0-4e0c-8f9a-10368c0180f6",
"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-08-12T08:08:18.0645351+00:00"
},
"modified_dateutc": "2026-08-12T08:08:18.0645351+00:00"
},
"equipment_model_id": "95eaea54-f4b1-42fd-8316-67e1be4a1d09",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1152fcd3-6fe8-4d6d-95c5-debff5e9f325",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1b016747-b51e-42df-8e7a-1fc52b90b7ea",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "dc76ba69-067d-4c71-a9fb-ae0ca0a425e3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0ba0ca90-6893-4250-b13f-bf085c5c5a3a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "34888275-a199-4312-a5ab-6631eba38ef7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0af47eba-c3ad-4ae0-85ab-b8a5664a6eb7",
"db_currency_id": "8f72f7f4-483c-4647-9ce0-1ec91d1e8be5",
"db_language_id": "901ff218-e7f0-4e0c-8f9a-10368c0180f6",
"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-08-12T08:08:18.0645351+00:00"
},
"modified_dateutc": "2026-08-12T08:08:18.0645351+00:00"
},
"equipment_family_id": "21ff245d-29d4-4a4c-940b-bd8aae2a2434",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "cf0e0fc6-d901-42cb-9242-1c18c58b913c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7bdab814-4dfb-477c-80ab-4b483b027b75",
"_parent_code": "sample string 6",
"sales_organization_id": "fd45f539-10ab-42c2-8510-a31b08a59cb5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "34888275-a199-4312-a5ab-6631eba38ef7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0af47eba-c3ad-4ae0-85ab-b8a5664a6eb7",
"db_currency_id": "8f72f7f4-483c-4647-9ce0-1ec91d1e8be5",
"db_language_id": "901ff218-e7f0-4e0c-8f9a-10368c0180f6",
"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-08-12T08:08:18.0645351+00:00"
},
"modified_dateutc": "2026-08-12T08:08:18.0645351+00:00"
},
"date_in_production_since": "2026-08-12T08:08:18.0645351+00:00",
"date_out_of_production_since": "2026-08-12T08:08:18.0645351+00:00",
"date_end_support": "2026-08-12T08:08:18.0645351+00:00",
"sales_organization_id": "024755b7-5388-41ae-8130-102feb8ac5b1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "34888275-a199-4312-a5ab-6631eba38ef7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0af47eba-c3ad-4ae0-85ab-b8a5664a6eb7",
"db_currency_id": "8f72f7f4-483c-4647-9ce0-1ec91d1e8be5",
"db_language_id": "901ff218-e7f0-4e0c-8f9a-10368c0180f6",
"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-08-12T08:08:18.0645351+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-08-12T08:08:18.0645351+00:00"
},
"project_status_id": "5c9ad6bd-9861-442e-92d6-53eb0c1f2847",
"project_status_code": "sample string 10",
"project_status": {
"id": "6c2cbc8d-7c3f-4677-a9e3-ccae8ff24acf",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "002d6960-c5c9-4322-a123-3c69a1d1dc19",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "34888275-a199-4312-a5ab-6631eba38ef7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0af47eba-c3ad-4ae0-85ab-b8a5664a6eb7",
"db_currency_id": "8f72f7f4-483c-4647-9ce0-1ec91d1e8be5",
"db_language_id": "901ff218-e7f0-4e0c-8f9a-10368c0180f6",
"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-08-12T08:08:18.0645351+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-12T08:08:18.0645351+00:00"
},
"company_id": "011795cf-31e4-4df3-9cfa-1ea7ecb6813c",
"company_code": "sample string 12",
"db_address_id": "3049af8a-5fb2-4996-a055-c2fb8a329719",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "07df20a2-6ef4-4e8d-a2b7-5e28e25af0cc",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e2281068-9ab6-4fc0-aa2f-8a4f9a0ca1ea",
"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-08-12T08:08:18.0645351+00:00",
"date_create": "2026-08-12T08:08:18.0645351+00:00",
"date_update": "2026-08-12T08:08:18.0645351+00:00",
"updated_by_user_id": "d2b4b3d3-f408-49ab-8178-2e5339c0ee7c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-12T08:08:18.0645351+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-08-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-12T08:08:18.0645351+00:00",
"date_last_job": "2026-08-12T08:08:18.0645351+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-12T08:08:18.0645351+00:00",
"modified_dateutc": "2026-08-12T08:08:18.0645351+00:00",
"is_mobile_installation": true
},
"job_type_id": "4bf3f5be-c234-48bb-8f87-935e5ec308c7",
"job_type_code": "sample string 7",
"job_type": {
"id": "e7295db5-a337-4894-b828-a102851159e9",
"name": "sample string 2",
"sales_organization_id": "c9dcff5f-b482-4763-a0f4-4777630974ce",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-12T08:08:18.0645351+00:00",
"code": "sample string 7"
},
"job_priority_id": "73cd0c43-316b-4580-8452-769e05573a72",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f3a4bcfb-96ba-4eab-b792-fa42f1e219e4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4b7fb454-2685-4c25-af9c-96f99f853f32",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "34888275-a199-4312-a5ab-6631eba38ef7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0af47eba-c3ad-4ae0-85ab-b8a5664a6eb7",
"db_currency_id": "8f72f7f4-483c-4647-9ce0-1ec91d1e8be5",
"db_language_id": "901ff218-e7f0-4e0c-8f9a-10368c0180f6",
"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-08-12T08:08:18.0645351+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-12T08:08:18.0645351+00:00"
},
"job_status_id": "874374f9-89cd-476c-af06-28aec7ad4ae5",
"job_status_code": "sample string 11",
"db_address_id": "786cc3a6-0e3f-42b2-8a2e-5ab2ba873b71",
"contact_id": "507713db-8cfa-45f3-b78a-84129fa86c24",
"requested_by_company_id": "dbfd9a36-aee2-41f5-b6bd-6e555976bf82",
"requested_by_contact_id": "6efb935d-fef1-4c0d-886c-6df026442b34",
"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-08-12T08:08:18.0645351+00:00",
"due_date": "2026-08-12T08:08:18.0645351+00:00",
"date_create": "2026-08-12T08:08:18.0645351+00:00",
"date_update": "2026-08-12T08:08:18.0645351+00:00",
"date_closed": "2026-08-12T08:08:18.0645351+00:00",
"suggested_user_id": "205abbeb-bbfd-4702-8909-65c9ec3aac9d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c290cc55-7f28-4b13-9ad8-866b96e14ce9",
"db_language_id": "2ae18130-c51d-43e3-8c86-fb06d8930894",
"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-08-12T08:08:18.0645351+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "bbd1d12e-86bc-4e6b-8c73-f5da1f87f7d6",
"sales_organization": {
"id": "34888275-a199-4312-a5ab-6631eba38ef7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0af47eba-c3ad-4ae0-85ab-b8a5664a6eb7",
"db_currency_id": "8f72f7f4-483c-4647-9ce0-1ec91d1e8be5",
"db_language_id": "901ff218-e7f0-4e0c-8f9a-10368c0180f6",
"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-08-12T08:08:18.0645351+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c8a049b9-1e61-45ab-8132-2e8714741eee",
"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": "3b1d8d73-e195-4e46-8a4c-e4f8768831af",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-12T08:08:18.0645351+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6b88135f-077a-430b-8698-add058630f23"
},
"suggested_date_start": "2026-08-12T08:08:18.0645351+00:00",
"skill_id": "ffda0a1e-95d6-438e-8f50-51e53160ec50",
"skill_code": "sample string 32",
"skill": {
"id": "cee89454-052f-4bf2-8169-54b23f915a89",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2e4d83bd-265c-46b2-878a-1ca2329277f4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "34888275-a199-4312-a5ab-6631eba38ef7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0af47eba-c3ad-4ae0-85ab-b8a5664a6eb7",
"db_currency_id": "8f72f7f4-483c-4647-9ce0-1ec91d1e8be5",
"db_language_id": "901ff218-e7f0-4e0c-8f9a-10368c0180f6",
"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-08-12T08:08:18.0645351+00:00"
},
"modified_dateutc": "2026-08-12T08:08:18.0645351+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9790ecd0-f749-4b49-bb24-a5a7f886ecf4",
"date_reported_by_company": "2026-08-12T08:08:18.0645351+00:00",
"id2": 36,
"company_id": "e5d02452-aeb6-48ec-b011-2b1912e311fc",
"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": "1d362ed0-a375-4639-a43b-2fe81c8434de",
"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-08-12T08:08:18.0645351+00:00"
},
"work_instruction_details_id": "af12ec8b-1e20-404e-a7d6-a2a6caa6450d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "eac1eaa0-3d30-42fe-b3a0-20865c80908d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bba58e3a-9774-4056-8bcf-af2ba48635d8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-12T08:08:18.0645351+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": "e36f1398-2cd9-41aa-ae23-18cf79843d9b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-12T08:08:18.0645351+00:00"
}