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": "f19655f0-bab5-4d54-851f-80aea9091e33",
"jobs_id": "671ad108-73ab-4e08-9ab0-b402a2c2fd0f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7e46ca1c-ec9b-4710-b1e7-ea8e5a078718",
"_parent_id": "8029962d-d778-47df-b5f7-c44b0307daca",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "37425af9-a83f-4233-81c7-dfc5dc7768b6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "73fe0de0-ef5a-4ebe-8024-8ad4da08908e",
"_parent_id": "6a4b252c-0f48-4436-9dcd-dba91b5f46a7",
"root_parent_id": "1bb3e860-033b-409e-950d-26f8dc0a3d34",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7928494e-5bfa-4409-90c3-bc5bf9a59970",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3427f651-3345-4e8e-ac75-20d97ee2fdb0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c19c6688-9306-4c8a-bdf7-f88c3867eb38",
"_parent_code": "sample string 6",
"sales_organization_id": "8990dd99-a9bf-46c7-a374-3a462dece138",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7fee6f5f-602a-404f-938b-a1a9197f9e16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf17b7b0-7315-4f9f-babb-236b4c2d55e8",
"db_currency_id": "a4521888-1d6d-4e41-b5d9-1fab1c9dec68",
"db_language_id": "11acee01-f4be-411b-8313-e31e2985c718",
"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-08-02T12:32:39.5141365+00:00"
},
"modified_dateutc": "2026-08-02T12:32:39.5141365+00:00"
},
"equipment_model_id": "5ffb24a9-4221-4afd-9825-91aba1e46633",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "04e7cfbe-265f-4cd6-8c24-02d693a7dafc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "06fc667f-aa42-4fea-b480-098c37f8b06a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "94efd0fe-598f-4376-9425-0c8ce62021c0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1373eedb-4fdc-4409-9dc7-838eabb07e3c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7fee6f5f-602a-404f-938b-a1a9197f9e16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf17b7b0-7315-4f9f-babb-236b4c2d55e8",
"db_currency_id": "a4521888-1d6d-4e41-b5d9-1fab1c9dec68",
"db_language_id": "11acee01-f4be-411b-8313-e31e2985c718",
"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-08-02T12:32:39.5141365+00:00"
},
"modified_dateutc": "2026-08-02T12:32:39.5141365+00:00"
},
"equipment_family_id": "4766fd39-1638-4241-8420-16e60c2075a2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3427f651-3345-4e8e-ac75-20d97ee2fdb0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c19c6688-9306-4c8a-bdf7-f88c3867eb38",
"_parent_code": "sample string 6",
"sales_organization_id": "8990dd99-a9bf-46c7-a374-3a462dece138",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7fee6f5f-602a-404f-938b-a1a9197f9e16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf17b7b0-7315-4f9f-babb-236b4c2d55e8",
"db_currency_id": "a4521888-1d6d-4e41-b5d9-1fab1c9dec68",
"db_language_id": "11acee01-f4be-411b-8313-e31e2985c718",
"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-08-02T12:32:39.5141365+00:00"
},
"modified_dateutc": "2026-08-02T12:32:39.5141365+00:00"
},
"date_in_production_since": "2026-08-02T12:32:39.5141365+00:00",
"date_out_of_production_since": "2026-08-02T12:32:39.5141365+00:00",
"date_end_support": "2026-08-02T12:32:39.5141365+00:00",
"sales_organization_id": "21cbbb73-2714-4e1c-9fee-9e30d6a04d92",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7fee6f5f-602a-404f-938b-a1a9197f9e16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf17b7b0-7315-4f9f-babb-236b4c2d55e8",
"db_currency_id": "a4521888-1d6d-4e41-b5d9-1fab1c9dec68",
"db_language_id": "11acee01-f4be-411b-8313-e31e2985c718",
"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-08-02T12:32:39.5141365+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-08-02T12:32:39.5141365+00:00"
},
"project_status_id": "aec620f6-89e7-457b-9664-9b681a792e56",
"project_status_code": "sample string 10",
"project_status": {
"id": "158bc481-0f31-49f6-8a62-6ef982f089d0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8f82b96f-e2d4-4171-a77f-0e82d39b5d99",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7fee6f5f-602a-404f-938b-a1a9197f9e16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf17b7b0-7315-4f9f-babb-236b4c2d55e8",
"db_currency_id": "a4521888-1d6d-4e41-b5d9-1fab1c9dec68",
"db_language_id": "11acee01-f4be-411b-8313-e31e2985c718",
"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-08-02T12:32:39.5141365+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-02T12:32:39.5141365+00:00"
},
"company_id": "5ded8e32-f477-4b2e-84b5-75655ee6e206",
"company_code": "sample string 12",
"db_address_id": "d449206b-b240-43fc-8630-1f1e037695e0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ba0d71f8-0a12-40be-8a23-8f109b84f1e0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0efb37c9-3509-4eaf-9dc8-48aa0e852cb0",
"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-08-02T12:32:39.5141365+00:00",
"date_create": "2026-08-02T12:32:39.5141365+00:00",
"date_update": "2026-08-02T12:32:39.5141365+00:00",
"updated_by_user_id": "68fd7169-06ca-4de7-9658-762841ec3b52",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-02T12:32:39.5141365+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-08-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-02T12:32:39.5141365+00:00",
"date_last_job": "2026-08-02T12:32:39.5141365+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-02T12:32:39.5141365+00:00",
"modified_dateutc": "2026-08-02T12:32:39.5141365+00:00",
"is_mobile_installation": true
},
"job_type_id": "b02460e1-ad03-43dc-9734-1f2ab887a878",
"job_type_code": "sample string 7",
"job_type": {
"id": "a0b54ab3-6e0f-461b-85d7-7e7f5e0c7642",
"name": "sample string 2",
"sales_organization_id": "218d685e-59da-4cfd-a3a1-589f11c3f6fe",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-02T12:32:39.5141365+00:00",
"code": "sample string 7"
},
"job_priority_id": "8a1a6bf8-1e45-46b6-b08a-3c933fe5bc22",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2fd76b98-11a1-4270-9779-05ffa979c67a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "58c3293c-9594-4929-9c13-128753293129",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7fee6f5f-602a-404f-938b-a1a9197f9e16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf17b7b0-7315-4f9f-babb-236b4c2d55e8",
"db_currency_id": "a4521888-1d6d-4e41-b5d9-1fab1c9dec68",
"db_language_id": "11acee01-f4be-411b-8313-e31e2985c718",
"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-08-02T12:32:39.5141365+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-02T12:32:39.5141365+00:00"
},
"job_status_id": "e013d400-7d45-43d9-94e3-239ff142ba82",
"job_status_code": "sample string 11",
"db_address_id": "f286abd6-49cb-4ea1-a944-75a08cc2273b",
"contact_id": "cc29922e-0d9b-44c4-a7cc-c4121fffc7cb",
"requested_by_company_id": "f8eede6e-a111-4fc4-8286-4b40bd77ef77",
"requested_by_contact_id": "8d05cccd-f820-47ee-9c1c-d7c787fa5d39",
"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-08-02T12:32:39.5141365+00:00",
"due_date": "2026-08-02T12:32:39.5141365+00:00",
"date_create": "2026-08-02T12:32:39.5141365+00:00",
"date_update": "2026-08-02T12:32:39.5141365+00:00",
"date_closed": "2026-08-02T12:32:39.5141365+00:00",
"suggested_user_id": "3cd54e14-1e11-4f6e-8144-6a8f4d624cde",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "642d7737-e881-4859-b563-cda8b136645f",
"db_language_id": "0448b030-5acd-43a5-9c02-8057fca1ed89",
"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-08-02T12:32:39.5141365+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "566f8b61-cb7b-45da-94d4-47c5bca34b29",
"sales_organization": {
"id": "7fee6f5f-602a-404f-938b-a1a9197f9e16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf17b7b0-7315-4f9f-babb-236b4c2d55e8",
"db_currency_id": "a4521888-1d6d-4e41-b5d9-1fab1c9dec68",
"db_language_id": "11acee01-f4be-411b-8313-e31e2985c718",
"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-08-02T12:32:39.5141365+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b27d68a6-4818-472b-ba67-11cbccac81bc",
"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": "8010815f-416d-4b5e-be37-e125d77e5c08",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-02T12:32:39.5141365+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4511db07-8feb-403c-b692-4d73611fe995"
},
"suggested_date_start": "2026-08-02T12:32:39.5141365+00:00",
"skill_id": "c1b3a91b-21f1-44d9-9bec-11b461f0d622",
"skill_code": "sample string 32",
"skill": {
"id": "5e086f5c-255f-44ee-92b0-fa609d17e0c2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c3efa24e-85a4-4bb4-a210-9911d73b01f6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7fee6f5f-602a-404f-938b-a1a9197f9e16",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf17b7b0-7315-4f9f-babb-236b4c2d55e8",
"db_currency_id": "a4521888-1d6d-4e41-b5d9-1fab1c9dec68",
"db_language_id": "11acee01-f4be-411b-8313-e31e2985c718",
"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-08-02T12:32:39.5141365+00:00"
},
"modified_dateutc": "2026-08-02T12:32:39.5141365+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8ba80362-fceb-4cb7-9172-06dd865f7aa0",
"date_reported_by_company": "2026-08-02T12:32:39.5141365+00:00",
"id2": 36,
"company_id": "4b1f619d-0a3a-4b41-b874-d7589d0201a7",
"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": "64225fc4-bcd4-44cd-8d95-ed1d8002a8fe",
"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-08-02T12:32:39.5141365+00:00"
},
"work_instruction_details_id": "e7a4f939-ce9c-45d1-9a56-e4a8611adf3c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fa737da0-cdf9-498d-bfb2-461a48ffb9dd",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4ca1eeb4-812f-49ec-a530-61ca8ab9cb33",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-02T12:32:39.5141365+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": "f86b7a1c-6f2f-4ff9-879c-feb91de6b753",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-02T12:32:39.5141365+00:00"
}