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": "280f8732-6d54-42f7-b475-102712420357",
"jobs_id": "ed29d296-c62d-4f22-b307-109c4e25980b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "326deb6c-0a3e-471e-a4ca-c79bad40ae9a",
"_parent_id": "c671e048-7a40-48f7-9e37-e816e911bbb4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "863b0121-23f7-42fa-a416-57d521720920",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ad63da5b-dcca-465d-a0f0-14f4648e866f",
"_parent_id": "29294c90-cff1-47c6-b498-8d8f07c6e505",
"root_parent_id": "a787b722-400c-4f7e-a517-a167cbf7959d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9b0368b7-23d6-4866-a050-388ee028e37f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "072e46da-00f2-428e-be4d-7a154799e57e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1da1de9e-55ea-4412-9b96-8134f1d329af",
"_parent_code": "sample string 6",
"sales_organization_id": "448fcb29-80ef-41f3-a60f-6395a88e63da",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b10867fd-d809-4691-9acc-8f1f81d753db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c35f34c-f511-4145-8c6f-4c45835f939a",
"db_currency_id": "789b08be-f5b5-434f-bf78-f13fd797c288",
"db_language_id": "6e4335a5-42e2-48e9-8fea-8950a0eab541",
"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-07-24T09:58:36.8906172+00:00"
},
"modified_dateutc": "2026-07-24T09:58:36.8906172+00:00"
},
"equipment_model_id": "d7b7ec63-9c2b-4c17-8aad-2c3c5a7f2236",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "dd935cd8-0872-43ec-98d0-88f2c32a71fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6060e5f3-1fcb-4fa0-938b-2156370b523a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "69863154-729b-4714-9e46-86c1af4bb58e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "75434005-c1f7-4423-9b6e-eb01ba18f021",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b10867fd-d809-4691-9acc-8f1f81d753db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c35f34c-f511-4145-8c6f-4c45835f939a",
"db_currency_id": "789b08be-f5b5-434f-bf78-f13fd797c288",
"db_language_id": "6e4335a5-42e2-48e9-8fea-8950a0eab541",
"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-07-24T09:58:36.8906172+00:00"
},
"modified_dateutc": "2026-07-24T09:58:36.8906172+00:00"
},
"equipment_family_id": "be974ab1-2a73-4093-8008-db7166549fa8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "072e46da-00f2-428e-be4d-7a154799e57e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1da1de9e-55ea-4412-9b96-8134f1d329af",
"_parent_code": "sample string 6",
"sales_organization_id": "448fcb29-80ef-41f3-a60f-6395a88e63da",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b10867fd-d809-4691-9acc-8f1f81d753db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c35f34c-f511-4145-8c6f-4c45835f939a",
"db_currency_id": "789b08be-f5b5-434f-bf78-f13fd797c288",
"db_language_id": "6e4335a5-42e2-48e9-8fea-8950a0eab541",
"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-07-24T09:58:36.8906172+00:00"
},
"modified_dateutc": "2026-07-24T09:58:36.8906172+00:00"
},
"date_in_production_since": "2026-07-24T09:58:36.8906172+00:00",
"date_out_of_production_since": "2026-07-24T09:58:36.8906172+00:00",
"date_end_support": "2026-07-24T09:58:36.8906172+00:00",
"sales_organization_id": "4e0711ed-1731-4737-ac72-3cd61144ba6d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b10867fd-d809-4691-9acc-8f1f81d753db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c35f34c-f511-4145-8c6f-4c45835f939a",
"db_currency_id": "789b08be-f5b5-434f-bf78-f13fd797c288",
"db_language_id": "6e4335a5-42e2-48e9-8fea-8950a0eab541",
"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-07-24T09:58:36.8906172+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-07-24T09:58:36.8906172+00:00"
},
"project_status_id": "da7fc93a-d0d6-4dfb-bf37-429968ab1198",
"project_status_code": "sample string 10",
"project_status": {
"id": "ba247ae0-f18d-49c9-95ce-421eedd3af24",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "66d05d3a-c262-4028-ae29-28b8fe4b910c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b10867fd-d809-4691-9acc-8f1f81d753db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c35f34c-f511-4145-8c6f-4c45835f939a",
"db_currency_id": "789b08be-f5b5-434f-bf78-f13fd797c288",
"db_language_id": "6e4335a5-42e2-48e9-8fea-8950a0eab541",
"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-07-24T09:58:36.8906172+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-24T09:58:36.8906172+00:00"
},
"company_id": "729029ce-04f7-40d4-972e-31b538273d73",
"company_code": "sample string 12",
"db_address_id": "1db02de3-8bd7-4d7d-9cad-097cc5b48098",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "82d10f9f-d928-4ec6-be48-93898a47f235",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "43ae85db-6af0-4d60-9d9d-947b67024552",
"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-07-24T09:58:36.8906172+00:00",
"date_create": "2026-07-24T09:58:36.8906172+00:00",
"date_update": "2026-07-24T09:58:36.8906172+00:00",
"updated_by_user_id": "5445346d-06ad-4166-81c5-90cffd4078e9",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-24T09:58:36.8906172+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-07-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-24T09:58:36.8906172+00:00",
"date_last_job": "2026-07-24T09:58:36.8906172+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-24T09:58:36.8906172+00:00",
"modified_dateutc": "2026-07-24T09:58:36.8906172+00:00",
"is_mobile_installation": true
},
"job_type_id": "44cd134e-9c5b-4c1e-b11c-f2efb75e6a4b",
"job_type_code": "sample string 7",
"job_type": {
"id": "5c9bfb32-3639-4bcf-9cc9-c3ee1d94d57c",
"name": "sample string 2",
"sales_organization_id": "98af1672-b24d-47ad-ad5e-84a8073b8aa7",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-24T09:58:36.8906172+00:00",
"code": "sample string 7"
},
"job_priority_id": "630f1950-1876-461d-959f-f060ad4e8ff9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0c634179-b72a-47f9-b52b-53c60dbd81b5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5dd70565-c89c-4647-813e-2e4e1dbc6bb1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b10867fd-d809-4691-9acc-8f1f81d753db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c35f34c-f511-4145-8c6f-4c45835f939a",
"db_currency_id": "789b08be-f5b5-434f-bf78-f13fd797c288",
"db_language_id": "6e4335a5-42e2-48e9-8fea-8950a0eab541",
"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-07-24T09:58:36.8906172+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-24T09:58:36.8906172+00:00"
},
"job_status_id": "81bef626-e731-4c17-8a84-4c586dc729e5",
"job_status_code": "sample string 11",
"db_address_id": "22143a10-b3c4-4f19-9122-418d7ef4c5ce",
"contact_id": "e845afd1-94e1-4516-81fd-9a6dbe6c89c3",
"requested_by_company_id": "b0715bfe-2d97-4c89-a630-22e2e9de0b54",
"requested_by_contact_id": "72b3f644-bfd5-498e-905f-049db98368f7",
"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-07-24T09:58:36.8906172+00:00",
"due_date": "2026-07-24T09:58:36.8906172+00:00",
"date_create": "2026-07-24T09:58:36.8906172+00:00",
"date_update": "2026-07-24T09:58:36.8906172+00:00",
"date_closed": "2026-07-24T09:58:36.8906172+00:00",
"suggested_user_id": "f5e28311-3d95-44fe-aa8b-cab2770e1032",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9487e966-38c1-4fa9-a131-8f2e1066b718",
"db_language_id": "2f0ade2e-fc8a-40a5-8ce9-973546c16621",
"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-07-24T09:58:36.8906172+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "a7aacf3e-5712-47ea-8b37-aa28a4005032",
"sales_organization": {
"id": "b10867fd-d809-4691-9acc-8f1f81d753db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c35f34c-f511-4145-8c6f-4c45835f939a",
"db_currency_id": "789b08be-f5b5-434f-bf78-f13fd797c288",
"db_language_id": "6e4335a5-42e2-48e9-8fea-8950a0eab541",
"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-07-24T09:58:36.8906172+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8c01d765-56e5-45f8-8fb6-30a9502fbfb0",
"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": "d2e63b6e-474f-46ce-8b07-cbd174a8f6ef",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-24T09:58:36.8906172+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "edb7d066-67cd-4fca-bac3-d464e2c84fac"
},
"suggested_date_start": "2026-07-24T09:58:36.8906172+00:00",
"skill_id": "cfde003a-a08f-4d06-ad85-207a9dfeec2a",
"skill_code": "sample string 32",
"skill": {
"id": "d960e35c-282e-4a38-9958-8450a0cf6acf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "fb0aa49a-ecdb-4041-a10d-2b82ff909c7d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b10867fd-d809-4691-9acc-8f1f81d753db",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c35f34c-f511-4145-8c6f-4c45835f939a",
"db_currency_id": "789b08be-f5b5-434f-bf78-f13fd797c288",
"db_language_id": "6e4335a5-42e2-48e9-8fea-8950a0eab541",
"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-07-24T09:58:36.8906172+00:00"
},
"modified_dateutc": "2026-07-24T09:58:36.8906172+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9fef88cf-79a1-49cf-80b4-14ae80de1d52",
"date_reported_by_company": "2026-07-24T09:58:36.8906172+00:00",
"id2": 36,
"company_id": "450a78af-3991-4cc4-9464-4a3aefbe86ae",
"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": "79c6bbfe-59b5-4298-9f2f-6fcaa3338506",
"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-07-24T09:58:36.8906172+00:00"
},
"work_instruction_details_id": "dac36fcd-8dd7-4165-8d2b-3e6aabb85421",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7c4f6ed4-7ea1-48af-89d7-e5777c9373d3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ad41fade-48c2-4f9e-ba05-4a16535fb5e0",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-24T09:58:36.8906172+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": "2c0a0aee-7892-4cc0-b186-638a1791f959",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-24T09:58:36.8906172+00:00"
}