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": "2eac5675-1924-4805-9191-bc82ec96d031",
"jobs_id": "0f5d10ba-1448-4747-bd4e-9cb62ad1d69c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a55dc366-719d-4fcc-a579-f82581941173",
"_parent_id": "d9728551-ad52-44d7-8fff-adac31cf2f27",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "65e01b89-c635-4cd6-b399-384c6fc86221",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b6120d9f-5339-4371-a802-50a962dc899e",
"_parent_id": "f3c017fd-3878-4d9b-bcf5-4e4fb9341c54",
"root_parent_id": "73908393-8592-40b7-af9d-608f0a1148c6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ccc67899-68bb-45df-893a-11cf18d4ad41",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "6dce18da-351e-47af-aadd-82aa31b69662",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c37ad975-4636-434e-b990-8e06f7056e10",
"_parent_code": "sample string 6",
"sales_organization_id": "9196e8ef-3796-4fca-850a-6407032f1a9f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "55eb8741-c565-4e7d-941e-5196ba24b7a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90cf3eba-1703-4383-8e61-4b64ae82d7b8",
"db_currency_id": "56c58341-bc69-4c9e-8835-ce07a2b2a134",
"db_language_id": "edcbae2d-c7ed-43fb-9151-c69e3097975d",
"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-09-19T20:57:11.2671922+00:00"
},
"modified_dateutc": "2026-09-19T20:57:11.2671922+00:00"
},
"equipment_model_id": "490015c6-3839-454e-956d-96ed7253e3fd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1ccd6cae-d8c0-4c47-a1c5-44050d67557a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5054fdfb-ef82-4674-a7d0-8bb8279f188f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1a5f02b8-af41-4e99-afc2-c223ae05d0ae",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "14b71f6c-9991-4154-a79e-0acb5886e0f4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "55eb8741-c565-4e7d-941e-5196ba24b7a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90cf3eba-1703-4383-8e61-4b64ae82d7b8",
"db_currency_id": "56c58341-bc69-4c9e-8835-ce07a2b2a134",
"db_language_id": "edcbae2d-c7ed-43fb-9151-c69e3097975d",
"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-09-19T20:57:11.2671922+00:00"
},
"modified_dateutc": "2026-09-19T20:57:11.2671922+00:00"
},
"equipment_family_id": "2b399b8c-208b-41e5-bae1-23507247923a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "6dce18da-351e-47af-aadd-82aa31b69662",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c37ad975-4636-434e-b990-8e06f7056e10",
"_parent_code": "sample string 6",
"sales_organization_id": "9196e8ef-3796-4fca-850a-6407032f1a9f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "55eb8741-c565-4e7d-941e-5196ba24b7a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90cf3eba-1703-4383-8e61-4b64ae82d7b8",
"db_currency_id": "56c58341-bc69-4c9e-8835-ce07a2b2a134",
"db_language_id": "edcbae2d-c7ed-43fb-9151-c69e3097975d",
"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-09-19T20:57:11.2671922+00:00"
},
"modified_dateutc": "2026-09-19T20:57:11.2671922+00:00"
},
"date_in_production_since": "2026-09-19T20:57:11.2671922+00:00",
"date_out_of_production_since": "2026-09-19T20:57:11.2671922+00:00",
"date_end_support": "2026-09-19T20:57:11.2671922+00:00",
"sales_organization_id": "eced6a1f-a6dc-45b9-95d7-499e5a977bbb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "55eb8741-c565-4e7d-941e-5196ba24b7a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90cf3eba-1703-4383-8e61-4b64ae82d7b8",
"db_currency_id": "56c58341-bc69-4c9e-8835-ce07a2b2a134",
"db_language_id": "edcbae2d-c7ed-43fb-9151-c69e3097975d",
"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-09-19T20:57:11.2671922+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-09-19T20:57:11.2671922+00:00"
},
"project_status_id": "c6e73302-bdb2-4cd3-b3aa-0c3531f701c2",
"project_status_code": "sample string 10",
"project_status": {
"id": "bc58e8ba-3a19-4967-9c60-1391373e2b1a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a6848e7d-4ab8-4774-bc24-7f8c4a4c99d8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "55eb8741-c565-4e7d-941e-5196ba24b7a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90cf3eba-1703-4383-8e61-4b64ae82d7b8",
"db_currency_id": "56c58341-bc69-4c9e-8835-ce07a2b2a134",
"db_language_id": "edcbae2d-c7ed-43fb-9151-c69e3097975d",
"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-09-19T20:57:11.2671922+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-19T20:57:11.2671922+00:00"
},
"company_id": "296f2086-2153-4aff-b5ce-1eeedf789033",
"company_code": "sample string 12",
"db_address_id": "011523dd-51dd-4937-866e-6896214cfdf7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f3cf4e1a-5fed-4a6f-9cb8-df9bfc3dcebb",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9562f184-08bb-462e-8e12-5a4dc81bd28e",
"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-09-19T20:57:11.2671922+00:00",
"date_create": "2026-09-19T20:57:11.2671922+00:00",
"date_update": "2026-09-19T20:57:11.2671922+00:00",
"updated_by_user_id": "2ad9c57a-fbea-4cf0-a658-7067081b67c2",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-19T20:57:11.2671922+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-09-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-19T20:57:11.2671922+00:00",
"date_last_job": "2026-09-19T20:57:11.2671922+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-19T20:57:11.2671922+00:00",
"modified_dateutc": "2026-09-19T20:57:11.2671922+00:00",
"is_mobile_installation": true
},
"job_type_id": "2c42a5f5-8f44-49ac-8b1a-960fede57c88",
"job_type_code": "sample string 7",
"job_type": {
"id": "895e5692-ab4d-43a7-92fb-8da0030d2262",
"name": "sample string 2",
"sales_organization_id": "e48f8519-8582-43dc-8b15-15e489717f3d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-19T20:57:11.2671922+00:00",
"code": "sample string 7"
},
"job_priority_id": "ee3b6bad-8f2e-49e4-9f10-1b081e200fc7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2632c83e-222f-453b-9ef7-b5d388596939",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b6758e6a-8843-4ea6-b32a-0dd80320d175",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "55eb8741-c565-4e7d-941e-5196ba24b7a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90cf3eba-1703-4383-8e61-4b64ae82d7b8",
"db_currency_id": "56c58341-bc69-4c9e-8835-ce07a2b2a134",
"db_language_id": "edcbae2d-c7ed-43fb-9151-c69e3097975d",
"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-09-19T20:57:11.2671922+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-19T20:57:11.2671922+00:00"
},
"job_status_id": "1a09f926-99e7-439a-8431-a937175973ee",
"job_status_code": "sample string 11",
"db_address_id": "1ffc1399-1fa9-4802-a6ae-2f91e846de33",
"contact_id": "8cd6c1a4-2981-4568-a429-707455761ce4",
"requested_by_company_id": "16f85363-fde4-4b6f-b48e-6067d8018dea",
"requested_by_contact_id": "76cf5e16-349b-4b57-97cc-ffc1c0153f6d",
"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-09-19T20:57:11.2671922+00:00",
"due_date": "2026-09-19T20:57:11.2671922+00:00",
"date_create": "2026-09-19T20:57:11.2671922+00:00",
"date_update": "2026-09-19T20:57:11.2671922+00:00",
"date_closed": "2026-09-19T20:57:11.2671922+00:00",
"suggested_user_id": "86839321-ddd8-41d0-b1c9-ff115093dd54",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "68be5221-3940-4c8d-aadc-c00d10a5e8d3",
"db_language_id": "0d639441-be51-4748-af73-69351260e3e5",
"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-09-19T20:57:11.2671922+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5d7b5af0-3556-48f3-9ca0-e4396361991b",
"sales_organization": {
"id": "55eb8741-c565-4e7d-941e-5196ba24b7a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90cf3eba-1703-4383-8e61-4b64ae82d7b8",
"db_currency_id": "56c58341-bc69-4c9e-8835-ce07a2b2a134",
"db_language_id": "edcbae2d-c7ed-43fb-9151-c69e3097975d",
"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-09-19T20:57:11.2671922+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b9d5d6ea-847e-4ea6-9739-a94fb2426d95",
"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": "c3b9b7c8-c3d8-4e08-b3cd-fec55b0ac4d2",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-19T20:57:11.2671922+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c2d1dec5-d99e-406a-ab10-3b4896e8bbb8"
},
"suggested_date_start": "2026-09-19T20:57:11.2671922+00:00",
"skill_id": "e9cd2947-4a7d-4180-8165-2b694e974d4d",
"skill_code": "sample string 32",
"skill": {
"id": "ee3bf09b-ad2a-464f-8d6c-f40dffb54a90",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a3995d87-78f6-4192-b5f4-be1413995b02",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "55eb8741-c565-4e7d-941e-5196ba24b7a1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "90cf3eba-1703-4383-8e61-4b64ae82d7b8",
"db_currency_id": "56c58341-bc69-4c9e-8835-ce07a2b2a134",
"db_language_id": "edcbae2d-c7ed-43fb-9151-c69e3097975d",
"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-09-19T20:57:11.2671922+00:00"
},
"modified_dateutc": "2026-09-19T20:57:11.2671922+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "accc64e8-1c80-46be-8286-2ebfc1ed4215",
"date_reported_by_company": "2026-09-19T20:57:11.2671922+00:00",
"id2": 36,
"company_id": "f56eb3dc-dacf-4826-a005-59153461a8f8",
"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": "9f294e65-36cc-4498-9d76-584b3ffa8d6a",
"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-09-19T20:57:11.2671922+00:00"
},
"work_instruction_details_id": "8d8099cc-d7b4-4afd-a954-f335a5cde526",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "623eb2b3-e410-417a-932a-2edb388a7537",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e854589a-96a7-4f59-bcbd-cae2e5fe41d7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-19T20:57:11.2671922+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": "06feb8d8-25f6-4f87-b6c9-18786fd9862f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-19T20:57:11.2671922+00:00"
}