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": "7c55ee3a-e9e8-4972-ba03-f546116b2a89",
"jobs_id": "037281eb-305b-447d-8b1e-ae0fd70bd14a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "87b8dd4a-6b4f-4383-ad44-20c5a811042d",
"_parent_id": "573efd33-adec-40a8-8e43-06c22a57580f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "07aa725a-5fda-49f3-bd21-54e85b7084f6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e3005cc3-0e3e-47c0-ab0e-d5ac4b51e2c2",
"_parent_id": "1ec024c8-1fcd-40c6-8886-552f8d21aa7f",
"root_parent_id": "031fe444-8ad1-4b2c-8f2c-f2677cf52a85",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8fa66c5a-228f-4c25-ad9d-ca1258adf6e7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "20c14d65-7d73-404e-a7ef-5c0fb3836d14",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "983d1b3f-9635-4f5a-9fa8-c3e66eada714",
"_parent_code": "sample string 6",
"sales_organization_id": "fb8ee37b-691e-4877-bcb2-87068bf619c2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "433b77fd-1b3e-4df7-b8ce-6aafc44bda82",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3178aa0e-9692-4773-a6c7-3345518f67dd",
"db_currency_id": "53cd7ed5-aaa4-412b-ae12-c503ae85516f",
"db_language_id": "05fc2ce8-faca-4569-85f6-d67b2df387b0",
"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-01-25T08:04:40.0168609+00:00"
},
"modified_dateutc": "2026-01-25T08:04:40.0168609+00:00"
},
"equipment_model_id": "89ef9e78-1e4d-4d13-8842-cb35b3085a2b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d40f6b05-dafd-469d-8418-fd98c598d9a2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "35b3ed73-c679-4348-a9d5-4fb55a5489d5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "790ad0d9-dfc0-4569-90ba-b0763b108805",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1fcdf115-241c-412a-9265-45cbde16b869",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "433b77fd-1b3e-4df7-b8ce-6aafc44bda82",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3178aa0e-9692-4773-a6c7-3345518f67dd",
"db_currency_id": "53cd7ed5-aaa4-412b-ae12-c503ae85516f",
"db_language_id": "05fc2ce8-faca-4569-85f6-d67b2df387b0",
"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-01-25T08:04:40.0168609+00:00"
},
"modified_dateutc": "2026-01-25T08:04:40.0168609+00:00"
},
"equipment_family_id": "a228d4b7-85a2-4d3b-9734-6ee3d90c541d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "20c14d65-7d73-404e-a7ef-5c0fb3836d14",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "983d1b3f-9635-4f5a-9fa8-c3e66eada714",
"_parent_code": "sample string 6",
"sales_organization_id": "fb8ee37b-691e-4877-bcb2-87068bf619c2",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "433b77fd-1b3e-4df7-b8ce-6aafc44bda82",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3178aa0e-9692-4773-a6c7-3345518f67dd",
"db_currency_id": "53cd7ed5-aaa4-412b-ae12-c503ae85516f",
"db_language_id": "05fc2ce8-faca-4569-85f6-d67b2df387b0",
"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-01-25T08:04:40.0168609+00:00"
},
"modified_dateutc": "2026-01-25T08:04:40.0168609+00:00"
},
"date_in_production_since": "2026-01-25T08:04:40.0168609+00:00",
"date_out_of_production_since": "2026-01-25T08:04:40.0168609+00:00",
"date_end_support": "2026-01-25T08:04:40.0168609+00:00",
"sales_organization_id": "121a6053-ac1c-41e2-9c86-2ff4cb9c9a07",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "433b77fd-1b3e-4df7-b8ce-6aafc44bda82",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3178aa0e-9692-4773-a6c7-3345518f67dd",
"db_currency_id": "53cd7ed5-aaa4-412b-ae12-c503ae85516f",
"db_language_id": "05fc2ce8-faca-4569-85f6-d67b2df387b0",
"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-01-25T08:04:40.0168609+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-01-25T08:04:40.0324845+00:00"
},
"project_status_id": "f79fcec4-0232-4ef0-8a67-e2c2e26108ce",
"project_status_code": "sample string 10",
"project_status": {
"id": "4ed1c6e8-cb77-4fbb-8662-90f9cf6951fe",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "4d3b9418-fe4b-434a-a95b-75ec26ba2d92",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "433b77fd-1b3e-4df7-b8ce-6aafc44bda82",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3178aa0e-9692-4773-a6c7-3345518f67dd",
"db_currency_id": "53cd7ed5-aaa4-412b-ae12-c503ae85516f",
"db_language_id": "05fc2ce8-faca-4569-85f6-d67b2df387b0",
"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-01-25T08:04:40.0168609+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-25T08:04:40.0324845+00:00"
},
"company_id": "b483b61d-e9de-4737-8995-050585acfb96",
"company_code": "sample string 12",
"db_address_id": "d1b4c9d0-4583-42ce-be41-7b11e0a2af27",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d05a182d-a71a-442c-8102-8dd7ab0d860b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "81a3802f-a81c-4807-94ac-f1bbea979b7a",
"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-01-25T08:04:40.0324845+00:00",
"date_create": "2026-01-25T08:04:40.0324845+00:00",
"date_update": "2026-01-25T08:04:40.0324845+00:00",
"updated_by_user_id": "e1b99293-15c3-493b-90cb-ed7fbdba0e74",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-25T08:04:40.0324845+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-01-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-25T08:04:40.0324845+00:00",
"date_last_job": "2026-01-25T08:04:40.0324845+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-25T08:04:40.0324845+00:00",
"modified_dateutc": "2026-01-25T08:04:40.0324845+00:00",
"is_mobile_installation": true
},
"job_type_id": "7cbdb09a-3da8-4939-a711-204231f290e1",
"job_type_code": "sample string 7",
"job_type": {
"id": "5a7b9ae2-9875-4337-b510-822b50c67137",
"name": "sample string 2",
"sales_organization_id": "2fa18f91-57df-4cfd-aff4-a9c9e07c083f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-25T08:04:40.0324845+00:00",
"code": "sample string 7"
},
"job_priority_id": "81a2cc4b-3ba2-473d-a7aa-b2b7e0ef57b7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7b1bdc34-04ae-4709-b533-f6ddad1ca486",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a13d795d-b5df-4e8c-a51c-f4cda497acd5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "433b77fd-1b3e-4df7-b8ce-6aafc44bda82",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3178aa0e-9692-4773-a6c7-3345518f67dd",
"db_currency_id": "53cd7ed5-aaa4-412b-ae12-c503ae85516f",
"db_language_id": "05fc2ce8-faca-4569-85f6-d67b2df387b0",
"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-01-25T08:04:40.0168609+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-25T08:04:40.0324845+00:00"
},
"job_status_id": "04796d9e-5074-4319-ae28-8c4bf9f39375",
"job_status_code": "sample string 11",
"db_address_id": "f3c12aca-09ad-48d8-95af-64401215fe54",
"contact_id": "7cbccc74-2a82-4958-8b4b-f9558f740245",
"requested_by_company_id": "2ecd7b60-1dfa-4f33-9c46-45a59fe252ab",
"requested_by_contact_id": "0d429180-3e85-492a-825d-b2fea5a6fe92",
"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-01-25T08:04:40.0324845+00:00",
"due_date": "2026-01-25T08:04:40.0324845+00:00",
"date_create": "2026-01-25T08:04:40.0324845+00:00",
"date_update": "2026-01-25T08:04:40.0324845+00:00",
"date_closed": "2026-01-25T08:04:40.0324845+00:00",
"suggested_user_id": "f3fa15dc-3015-482d-8a49-62707ab0fc64",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b550470e-ad46-4538-a55c-627f95244924",
"db_language_id": "5266e26a-2111-4d32-9da0-34b4e20a751c",
"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-01-25T08:04:40.0324845+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "46241a1d-93d4-44e3-a866-04f964ecda26",
"sales_organization": {
"id": "433b77fd-1b3e-4df7-b8ce-6aafc44bda82",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3178aa0e-9692-4773-a6c7-3345518f67dd",
"db_currency_id": "53cd7ed5-aaa4-412b-ae12-c503ae85516f",
"db_language_id": "05fc2ce8-faca-4569-85f6-d67b2df387b0",
"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-01-25T08:04:40.0168609+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5124c6f1-d4e6-41c7-a57c-5b473106ee73",
"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": "242a4a1a-d79d-484c-955b-9f1ede316ec9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-25T08:04:40.0324845+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b0d309df-19e2-4a82-ae3c-0de61c6d3d42"
},
"suggested_date_start": "2026-01-25T08:04:40.0324845+00:00",
"skill_id": "343d4870-23e8-4e96-8c32-8485664f8b6f",
"skill_code": "sample string 32",
"skill": {
"id": "df5757ca-db85-4121-9d44-c73b82e851f9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4a438ba3-b33c-40dd-9bce-b9606d0a1853",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "433b77fd-1b3e-4df7-b8ce-6aafc44bda82",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3178aa0e-9692-4773-a6c7-3345518f67dd",
"db_currency_id": "53cd7ed5-aaa4-412b-ae12-c503ae85516f",
"db_language_id": "05fc2ce8-faca-4569-85f6-d67b2df387b0",
"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-01-25T08:04:40.0168609+00:00"
},
"modified_dateutc": "2026-01-25T08:04:40.0324845+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "14b25629-2686-4d3c-8a8d-4e2f5b9a6614",
"date_reported_by_company": "2026-01-25T08:04:40.0324845+00:00",
"id2": 36,
"company_id": "acd84757-1224-4f4c-ac25-3fde7da5afef",
"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": "40b24697-b104-4b6e-8e24-5457d09a5426",
"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-01-25T08:04:40.0324845+00:00"
},
"work_instruction_details_id": "b3d257dc-748d-462c-91ed-343ff88e3d4f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "05064e24-e70b-45e5-a77a-03166ce52e92",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c9612c63-9c74-4357-8b1d-e9e0676f9957",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-25T08:04:40.0324845+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": "d7b57437-79b1-45a9-b32d-a01c0eb92af0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-25T08:04:40.0324845+00:00"
}