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": "646a401e-fee1-422f-8518-ebd2bd4d1bcc",
"jobs_id": "d0a01989-94fb-48cd-9438-119123ce56a1",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "14cd4f99-b770-4bde-a29d-402f96ccdef4",
"_parent_id": "9f4303e9-a097-4425-85e6-998d322544a5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fa844f4c-3169-4751-81b9-bf1fbd1bd46b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "776becb6-dd4c-491c-88f4-0e21ae10c55b",
"_parent_id": "cdf5449a-c474-4434-8ae9-43eacea20e1c",
"root_parent_id": "504c502f-60b8-4038-bda2-ce44189f4811",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8661912f-cb9f-4954-976c-860ae65e153d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a91e2d46-4b64-4cef-8528-bb28b69d59c8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e3b61958-08b4-4cb7-8c49-caea909e9d6e",
"_parent_code": "sample string 6",
"sales_organization_id": "34ae6715-ac92-4845-8d4a-d3d0d88d6512",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f1f75551-9f50-4779-9fd9-3565c7bead17",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57e9090f-0ce4-4f98-88d2-6b8ecb726912",
"db_currency_id": "f6c5d6fb-b647-48b8-b18f-3e85f9bb0554",
"db_language_id": "476c953e-fcee-42bf-bf5e-7b05ea7f7a41",
"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-11-08T18:41:24.1868764+00:00"
},
"modified_dateutc": "2026-11-08T18:41:24.1868764+00:00"
},
"equipment_model_id": "7136283f-e94c-46d1-8277-b164f8e1fbeb",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5165d0f8-7043-40ea-bacd-311bab44dc9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c1655e3f-79c7-40a3-a861-bd8257b4ad5b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d5598d8d-07f5-49a8-8a23-9d8dcd6e2c8f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c2cfbcf7-dfdd-4ae2-8c57-58148c5d54e2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f1f75551-9f50-4779-9fd9-3565c7bead17",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57e9090f-0ce4-4f98-88d2-6b8ecb726912",
"db_currency_id": "f6c5d6fb-b647-48b8-b18f-3e85f9bb0554",
"db_language_id": "476c953e-fcee-42bf-bf5e-7b05ea7f7a41",
"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-11-08T18:41:24.1868764+00:00"
},
"modified_dateutc": "2026-11-08T18:41:24.2047523+00:00"
},
"equipment_family_id": "4bd892cd-a274-4d3f-8ab9-505223b2eb99",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a91e2d46-4b64-4cef-8528-bb28b69d59c8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e3b61958-08b4-4cb7-8c49-caea909e9d6e",
"_parent_code": "sample string 6",
"sales_organization_id": "34ae6715-ac92-4845-8d4a-d3d0d88d6512",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f1f75551-9f50-4779-9fd9-3565c7bead17",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57e9090f-0ce4-4f98-88d2-6b8ecb726912",
"db_currency_id": "f6c5d6fb-b647-48b8-b18f-3e85f9bb0554",
"db_language_id": "476c953e-fcee-42bf-bf5e-7b05ea7f7a41",
"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-11-08T18:41:24.1868764+00:00"
},
"modified_dateutc": "2026-11-08T18:41:24.1868764+00:00"
},
"date_in_production_since": "2026-11-08T18:41:24.2047523+00:00",
"date_out_of_production_since": "2026-11-08T18:41:24.2047523+00:00",
"date_end_support": "2026-11-08T18:41:24.2047523+00:00",
"sales_organization_id": "9e3e725b-9446-4f65-ac49-e2faa881786a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f1f75551-9f50-4779-9fd9-3565c7bead17",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57e9090f-0ce4-4f98-88d2-6b8ecb726912",
"db_currency_id": "f6c5d6fb-b647-48b8-b18f-3e85f9bb0554",
"db_language_id": "476c953e-fcee-42bf-bf5e-7b05ea7f7a41",
"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-11-08T18:41:24.1868764+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-11-08T18:41:24.2047523+00:00"
},
"project_status_id": "e304dd3a-a4da-4167-a67f-160782108bd2",
"project_status_code": "sample string 10",
"project_status": {
"id": "01228a27-1cd1-4218-a039-51740266bead",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "340d006d-ebd7-4151-adf6-67401fe82702",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f1f75551-9f50-4779-9fd9-3565c7bead17",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57e9090f-0ce4-4f98-88d2-6b8ecb726912",
"db_currency_id": "f6c5d6fb-b647-48b8-b18f-3e85f9bb0554",
"db_language_id": "476c953e-fcee-42bf-bf5e-7b05ea7f7a41",
"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-11-08T18:41:24.1868764+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-08T18:41:24.2047523+00:00"
},
"company_id": "4dd3934c-d51d-486d-ad4b-71206f355aac",
"company_code": "sample string 12",
"db_address_id": "9031be87-4127-42bd-bcf2-a8ec4ce5d8fe",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0467d161-e9f1-46d2-bde0-55c69bc52af2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d3a172ff-7297-4cb4-9378-ca4dfc4f22f5",
"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-11-08T18:41:24.2047523+00:00",
"date_create": "2026-11-08T18:41:24.2047523+00:00",
"date_update": "2026-11-08T18:41:24.2047523+00:00",
"updated_by_user_id": "423f36ab-bc54-4d02-a96b-507a17900589",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-08T18:41:24.2047523+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-11-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-08T18:41:24.2047523+00:00",
"date_last_job": "2026-11-08T18:41:24.2047523+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-08T18:41:24.2047523+00:00",
"modified_dateutc": "2026-11-08T18:41:24.2047523+00:00",
"is_mobile_installation": true
},
"job_type_id": "6a2a10de-5c69-4d84-a5f4-c4ddcb3c3036",
"job_type_code": "sample string 7",
"job_type": {
"id": "ccd1b8ec-f068-44dd-952d-b7f96e7840a3",
"name": "sample string 2",
"sales_organization_id": "5aacf15e-1ef3-4ad4-b43a-dbb2318a124e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-08T18:41:24.2047523+00:00",
"code": "sample string 7"
},
"job_priority_id": "23c11000-4870-4b54-9c80-db9487ba6bea",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "95816cfc-27f2-42a4-9354-5226b9924df4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7c0654ea-9968-4e4e-baf4-f7ae2365c34b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f1f75551-9f50-4779-9fd9-3565c7bead17",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57e9090f-0ce4-4f98-88d2-6b8ecb726912",
"db_currency_id": "f6c5d6fb-b647-48b8-b18f-3e85f9bb0554",
"db_language_id": "476c953e-fcee-42bf-bf5e-7b05ea7f7a41",
"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-11-08T18:41:24.1868764+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-08T18:41:24.2047523+00:00"
},
"job_status_id": "e277b5f3-4306-475a-9fe7-2ca31d934fbb",
"job_status_code": "sample string 11",
"db_address_id": "a36b6e1e-4c0a-4835-b216-654c3fe088fa",
"contact_id": "d7b41d1b-1947-4b40-a259-9a1a7c2b63b9",
"requested_by_company_id": "5f609423-dcc8-477c-af3b-5d174288e671",
"requested_by_contact_id": "aae78e80-19e0-4e6d-99c8-a80797782ad1",
"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-11-08T18:41:24.2047523+00:00",
"due_date": "2026-11-08T18:41:24.2047523+00:00",
"date_create": "2026-11-08T18:41:24.2047523+00:00",
"date_update": "2026-11-08T18:41:24.2047523+00:00",
"date_closed": "2026-11-08T18:41:24.2047523+00:00",
"suggested_user_id": "d7707419-f3fa-4b22-8538-e8e821980699",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fa509323-933e-4beb-8091-25c619b97a4a",
"db_language_id": "ef38ff27-e319-4669-b7f5-7d19dc53da04",
"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-11-08T18:41:24.2047523+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "059b20f1-4d2a-4c5b-9c7d-4aef85b367e1",
"sales_organization": {
"id": "f1f75551-9f50-4779-9fd9-3565c7bead17",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57e9090f-0ce4-4f98-88d2-6b8ecb726912",
"db_currency_id": "f6c5d6fb-b647-48b8-b18f-3e85f9bb0554",
"db_language_id": "476c953e-fcee-42bf-bf5e-7b05ea7f7a41",
"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-11-08T18:41:24.1868764+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "745cd4a2-902e-4d63-99f1-37b3bc30c0bc",
"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": "0a2b6cbf-3f2d-4a19-ab7e-6275c7d07be0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-08T18:41:24.2047523+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2da26b1b-3d4a-47e0-b896-782ca954d023"
},
"suggested_date_start": "2026-11-08T18:41:24.2047523+00:00",
"skill_id": "50b11736-5d66-493b-a8e1-caea258cbc0a",
"skill_code": "sample string 32",
"skill": {
"id": "a4d23583-278d-48c6-a23c-65046d789890",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6c86a12b-ef91-4e75-a394-7ad999ea5127",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f1f75551-9f50-4779-9fd9-3565c7bead17",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57e9090f-0ce4-4f98-88d2-6b8ecb726912",
"db_currency_id": "f6c5d6fb-b647-48b8-b18f-3e85f9bb0554",
"db_language_id": "476c953e-fcee-42bf-bf5e-7b05ea7f7a41",
"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-11-08T18:41:24.1868764+00:00"
},
"modified_dateutc": "2026-11-08T18:41:24.2047523+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "61d88027-f4fc-4d43-8726-0131c8a02bc6",
"date_reported_by_company": "2026-11-08T18:41:24.2047523+00:00",
"id2": 36,
"company_id": "45eab73d-52eb-4b38-9b53-4f194ce29d9a",
"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": "709be98b-ec14-454c-8d61-bc7bbfbf5893",
"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-11-08T18:41:24.2047523+00:00"
},
"work_instruction_details_id": "9318262b-7986-4e77-8b46-5c0fbd746627",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "81235f4c-1264-4c4a-9b57-c6af30205473",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4e452c12-3bcd-471a-85ab-bf3ccf229a92",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-08T18:41:24.2047523+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": "aeb3c5bf-51c9-4054-bf63-d189c613ce18",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-08T18:41:24.2047523+00:00"
}