Retrieves all the job work instruction list.
Request Information
URI Parameters :
None.
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": "57829015-b5f9-4399-a753-fc00ef2294f9",
"jobs_id": "bf7459ef-19cf-4d73-a4cf-524a06a84a31",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9bb5feb3-40ca-463e-9d26-3a10496b65a5",
"_parent_id": "ecd93aba-a3c2-470f-914a-fe41641a483b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0e95858c-5e45-4e35-874c-4544dc740a8d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2758dce8-ed72-45fe-a911-e20c8da16141",
"_parent_id": "d1ca4a9e-e5fb-4090-b525-1b430ef0c74d",
"root_parent_id": "51b231de-ffc7-41f9-bb32-45402c477b41",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cf133226-7de2-4170-9ae1-e8df7961529a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c22bcee8-d2bc-4bd8-860a-b1d1e55cd451",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7d8c4c73-941a-4028-8187-7524d848ac35",
"_parent_code": "sample string 6",
"sales_organization_id": "73dd457f-009a-462a-88f3-52c73fa08887",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cf62f706-efc8-437b-9baf-eb1672649f13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40c2ac41-1c98-46c4-8e87-fa3286464f9b",
"db_currency_id": "b1776ef8-04b6-41b3-b15c-5514fd02f6aa",
"db_language_id": "87977824-465b-45f2-985f-d1596519f1f6",
"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-04-20T19:22:36.3387785+00:00"
},
"modified_dateutc": "2026-04-20T19:22:36.3387785+00:00"
},
"equipment_model_id": "6d505d35-5ca9-4c11-bcbf-c556520583b2",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b76ce1f0-0afa-41d1-98e5-501baba94060",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "30e0c9e1-fceb-4bb7-9cce-56fa7c26260b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7e9327bf-bef1-4d52-b5fa-249734ee5e00",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "75103cbc-0e24-405d-9890-c49584d0a5f9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "cf62f706-efc8-437b-9baf-eb1672649f13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40c2ac41-1c98-46c4-8e87-fa3286464f9b",
"db_currency_id": "b1776ef8-04b6-41b3-b15c-5514fd02f6aa",
"db_language_id": "87977824-465b-45f2-985f-d1596519f1f6",
"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-04-20T19:22:36.3387785+00:00"
},
"modified_dateutc": "2026-04-20T19:22:36.3387785+00:00"
},
"equipment_family_id": "691caba2-0df3-456b-8ff8-b1fa932ebfad",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c22bcee8-d2bc-4bd8-860a-b1d1e55cd451",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7d8c4c73-941a-4028-8187-7524d848ac35",
"_parent_code": "sample string 6",
"sales_organization_id": "73dd457f-009a-462a-88f3-52c73fa08887",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "cf62f706-efc8-437b-9baf-eb1672649f13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40c2ac41-1c98-46c4-8e87-fa3286464f9b",
"db_currency_id": "b1776ef8-04b6-41b3-b15c-5514fd02f6aa",
"db_language_id": "87977824-465b-45f2-985f-d1596519f1f6",
"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-04-20T19:22:36.3387785+00:00"
},
"modified_dateutc": "2026-04-20T19:22:36.3387785+00:00"
},
"date_in_production_since": "2026-04-20T19:22:36.3387785+00:00",
"date_out_of_production_since": "2026-04-20T19:22:36.3387785+00:00",
"date_end_support": "2026-04-20T19:22:36.3387785+00:00",
"sales_organization_id": "1f50d329-a213-481a-bf75-47bb9c8cda69",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "cf62f706-efc8-437b-9baf-eb1672649f13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40c2ac41-1c98-46c4-8e87-fa3286464f9b",
"db_currency_id": "b1776ef8-04b6-41b3-b15c-5514fd02f6aa",
"db_language_id": "87977824-465b-45f2-985f-d1596519f1f6",
"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-04-20T19:22:36.3387785+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-04-20T19:22:36.3387785+00:00"
},
"project_status_id": "0275eb3e-9fce-41a7-b6d7-f0a353ebf9d7",
"project_status_code": "sample string 10",
"project_status": {
"id": "5d7bf9c6-823c-4ab2-b980-ce168fac9816",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2aa248b1-1b76-4622-8478-7d29d4126a13",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cf62f706-efc8-437b-9baf-eb1672649f13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40c2ac41-1c98-46c4-8e87-fa3286464f9b",
"db_currency_id": "b1776ef8-04b6-41b3-b15c-5514fd02f6aa",
"db_language_id": "87977824-465b-45f2-985f-d1596519f1f6",
"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-04-20T19:22:36.3387785+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-20T19:22:36.3387785+00:00"
},
"company_id": "1a246e8b-e40a-40cb-b1ca-86b269e3fb57",
"company_code": "sample string 12",
"db_address_id": "d98884e3-9a91-43c8-8059-127af0de7d53",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8427a195-7b3c-4b39-8653-57c1426c8102",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cbf4edc6-5776-4bd1-81d2-d645ba6c1cf2",
"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-04-20T19:22:36.3387785+00:00",
"date_create": "2026-04-20T19:22:36.3387785+00:00",
"date_update": "2026-04-20T19:22:36.3387785+00:00",
"updated_by_user_id": "4ba7edb7-64d2-41fd-8bb6-d396814bb1c2",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-20T19:22:36.3387785+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-04-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-20T19:22:36.3387785+00:00",
"date_last_job": "2026-04-20T19:22:36.3387785+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-20T19:22:36.3387785+00:00",
"modified_dateutc": "2026-04-20T19:22:36.3387785+00:00",
"is_mobile_installation": true
},
"job_type_id": "985d588c-bd04-484a-a914-1b7fbaf6ae8c",
"job_type_code": "sample string 7",
"job_type": {
"id": "04c802bc-6ede-48e1-b55c-41b341f621c6",
"name": "sample string 2",
"sales_organization_id": "cda83caf-b639-48c1-940a-f59f7528fae0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-20T19:22:36.3387785+00:00",
"code": "sample string 7"
},
"job_priority_id": "889d8489-bd80-4bf8-9f37-e8f3acbfb506",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "68464dd1-b775-449b-9702-9c529d5154df",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "496a5ccd-6e0f-4a9f-8163-caa1918ab2d5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cf62f706-efc8-437b-9baf-eb1672649f13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40c2ac41-1c98-46c4-8e87-fa3286464f9b",
"db_currency_id": "b1776ef8-04b6-41b3-b15c-5514fd02f6aa",
"db_language_id": "87977824-465b-45f2-985f-d1596519f1f6",
"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-04-20T19:22:36.3387785+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-20T19:22:36.3387785+00:00"
},
"job_status_id": "1cc00184-9e4f-492f-8dd8-64b724b6b3ab",
"job_status_code": "sample string 11",
"db_address_id": "32b72611-cc8f-4dca-a8be-20f7f4a25c83",
"contact_id": "ac876150-89f2-4296-b5a6-6602bec414a4",
"requested_by_company_id": "51ba6e49-4e9b-490e-83f6-b5da96ba37e9",
"requested_by_contact_id": "43d03d24-7aa7-43c8-8649-8d48a8914090",
"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-04-20T19:22:36.3387785+00:00",
"due_date": "2026-04-20T19:22:36.3387785+00:00",
"date_create": "2026-04-20T19:22:36.3387785+00:00",
"date_update": "2026-04-20T19:22:36.3387785+00:00",
"date_closed": "2026-04-20T19:22:36.3387785+00:00",
"suggested_user_id": "6291b274-4714-4682-aa77-38db72998f5d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "539d4b52-8f9f-4f96-a162-aedab61b3577",
"db_language_id": "ecf5f168-1ba6-4a00-8158-f37db5eab1f1",
"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-04-20T19:22:36.3387785+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "99a0aa09-50bb-498a-bd43-c430333d2bb7",
"sales_organization": {
"id": "cf62f706-efc8-437b-9baf-eb1672649f13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40c2ac41-1c98-46c4-8e87-fa3286464f9b",
"db_currency_id": "b1776ef8-04b6-41b3-b15c-5514fd02f6aa",
"db_language_id": "87977824-465b-45f2-985f-d1596519f1f6",
"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-04-20T19:22:36.3387785+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7119ffae-67ca-4446-b0f5-e15acd230450",
"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": "4fe0d0ea-3630-4478-93cc-9fd442e088ec",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-20T19:22:36.3387785+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "29c21119-d370-401e-974a-1fa3dd2ccfdc"
},
"suggested_date_start": "2026-04-20T19:22:36.3387785+00:00",
"skill_id": "dc7bbd03-af8e-4e3a-bda3-48dbcaf5b926",
"skill_code": "sample string 32",
"skill": {
"id": "c84c306f-933b-4bcf-86e4-b53dbc228584",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "df1cb2e8-1866-4964-9c59-71cadc09a4e9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "cf62f706-efc8-437b-9baf-eb1672649f13",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40c2ac41-1c98-46c4-8e87-fa3286464f9b",
"db_currency_id": "b1776ef8-04b6-41b3-b15c-5514fd02f6aa",
"db_language_id": "87977824-465b-45f2-985f-d1596519f1f6",
"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-04-20T19:22:36.3387785+00:00"
},
"modified_dateutc": "2026-04-20T19:22:36.3387785+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e576d6eb-99b1-48df-ab8e-3ca3236073d3",
"date_reported_by_company": "2026-04-20T19:22:36.3387785+00:00",
"id2": 36,
"company_id": "553f3ec7-b6b6-4dce-821a-67c01e2b0562",
"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": "dec4f2b4-5227-47a2-9c88-94ee85e90829",
"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-04-20T19:22:36.3387785+00:00"
},
"work_instruction_details_id": "7610b562-8490-4180-bc97-848b9d317d7c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "adf062d9-f24e-4508-b9f2-7ec89d4c1a04",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b4877746-d0c5-44a2-bc79-70dc22400d44",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-20T19:22:36.3387785+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": "c5d32cc2-630d-47a6-957f-ef5a449b5655",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-20T19:22:36.3387785+00:00"
}