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": "604e57e4-c0ad-4bca-8c1e-ad7c45cfbd04",
"jobs_id": "4cd736fc-fce4-4d4f-8bac-3b86ab69edf2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e8e8dfab-9681-4ce1-86d9-0538a7ca6289",
"_parent_id": "0c385245-a484-4c74-b904-fe164bab7c97",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e60e7811-3b6d-4775-acd1-b03e37584bfc",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f6d98f6c-7099-4e7c-ba95-082f3721e0cb",
"_parent_id": "03931a71-eb51-4404-bc00-1581eeea0204",
"root_parent_id": "96f31b95-368b-44b2-a2cd-596393c71261",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "72bae9ee-3157-4d74-a57c-1c9935879488",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3f04c68c-a7d0-4f59-97cf-cd224953ffc7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6604dbfd-ab6b-4e6a-b4a0-581923ecf82b",
"_parent_code": "sample string 6",
"sales_organization_id": "979e3241-c8c3-4236-b528-9f9b2c0d7fd4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c1e53b05-fd9e-4176-b217-1184ca80d1f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea3b5fbb-46c1-4b58-a768-e301a9e376a4",
"db_currency_id": "d697aa24-6934-4519-862f-16d01e5eaaf4",
"db_language_id": "0019d5c1-7b90-4cdb-a80b-a1a52aaa25fb",
"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-29T14:31:08.987161+00:00"
},
"modified_dateutc": "2026-08-29T14:31:08.987161+00:00"
},
"equipment_model_id": "f381eb44-b711-4916-9090-d3c6eb6c87b1",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "56ad079e-93c6-482f-a598-e1dbe3fa1909",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5633d705-adfd-469b-95a5-c0191417dcb9",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "17bf233f-839c-4066-8fd6-b5e3343f4d1c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "9f402181-7d80-469c-a754-b6e807ebcd91",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c1e53b05-fd9e-4176-b217-1184ca80d1f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea3b5fbb-46c1-4b58-a768-e301a9e376a4",
"db_currency_id": "d697aa24-6934-4519-862f-16d01e5eaaf4",
"db_language_id": "0019d5c1-7b90-4cdb-a80b-a1a52aaa25fb",
"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-29T14:31:08.987161+00:00"
},
"modified_dateutc": "2026-08-29T14:31:08.987161+00:00"
},
"equipment_family_id": "4eb8d79c-5737-4c87-9bb8-44fb72e57994",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3f04c68c-a7d0-4f59-97cf-cd224953ffc7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "6604dbfd-ab6b-4e6a-b4a0-581923ecf82b",
"_parent_code": "sample string 6",
"sales_organization_id": "979e3241-c8c3-4236-b528-9f9b2c0d7fd4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c1e53b05-fd9e-4176-b217-1184ca80d1f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea3b5fbb-46c1-4b58-a768-e301a9e376a4",
"db_currency_id": "d697aa24-6934-4519-862f-16d01e5eaaf4",
"db_language_id": "0019d5c1-7b90-4cdb-a80b-a1a52aaa25fb",
"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-29T14:31:08.987161+00:00"
},
"modified_dateutc": "2026-08-29T14:31:08.987161+00:00"
},
"date_in_production_since": "2026-08-29T14:31:08.987161+00:00",
"date_out_of_production_since": "2026-08-29T14:31:08.987161+00:00",
"date_end_support": "2026-08-29T14:31:08.987161+00:00",
"sales_organization_id": "6878f0cd-f54f-4caa-82a1-af961fa3f01d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c1e53b05-fd9e-4176-b217-1184ca80d1f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea3b5fbb-46c1-4b58-a768-e301a9e376a4",
"db_currency_id": "d697aa24-6934-4519-862f-16d01e5eaaf4",
"db_language_id": "0019d5c1-7b90-4cdb-a80b-a1a52aaa25fb",
"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-29T14:31:08.987161+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-29T14:31:08.987161+00:00"
},
"project_status_id": "e1bdf9ab-fc95-4556-b8e2-bf43cc2d0c3e",
"project_status_code": "sample string 10",
"project_status": {
"id": "82dd8d9d-7be5-41e7-b41a-50067b414f5a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "52711986-10a5-485f-ad5e-0d7bcb4757c1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c1e53b05-fd9e-4176-b217-1184ca80d1f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea3b5fbb-46c1-4b58-a768-e301a9e376a4",
"db_currency_id": "d697aa24-6934-4519-862f-16d01e5eaaf4",
"db_language_id": "0019d5c1-7b90-4cdb-a80b-a1a52aaa25fb",
"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-29T14:31:08.987161+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-29T14:31:08.987161+00:00"
},
"company_id": "215c369e-a239-48cd-94f7-ec4aec43f2c4",
"company_code": "sample string 12",
"db_address_id": "4095cecf-59df-4b32-921c-76774783eeb9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a092777d-1c74-411a-8607-f77e568d2250",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4ae3485c-572d-484b-b487-e988dca79bc6",
"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-29T14:31:08.987161+00:00",
"date_create": "2026-08-29T14:31:08.987161+00:00",
"date_update": "2026-08-29T14:31:08.987161+00:00",
"updated_by_user_id": "d61234d7-6374-4d7d-95d2-7aecbd58e498",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-29T14:31:08.987161+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-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-29T14:31:08.987161+00:00",
"date_last_job": "2026-08-29T14:31:08.987161+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-29T14:31:08.987161+00:00",
"modified_dateutc": "2026-08-29T14:31:08.987161+00:00",
"is_mobile_installation": true
},
"job_type_id": "8436fa23-6515-48b9-9bcf-25757ccee9d0",
"job_type_code": "sample string 7",
"job_type": {
"id": "473e06a1-3189-49b0-beeb-c57097a37b7a",
"name": "sample string 2",
"sales_organization_id": "4230b6b8-54a9-4b40-86e5-d8b292024a94",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-29T14:31:08.987161+00:00",
"code": "sample string 7"
},
"job_priority_id": "3546bb27-1ef0-4645-922b-c411b99da71e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a6dd6be5-725d-4288-a501-a715f01a813f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c1881819-a5fb-4105-9596-3b4b576dc36a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c1e53b05-fd9e-4176-b217-1184ca80d1f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea3b5fbb-46c1-4b58-a768-e301a9e376a4",
"db_currency_id": "d697aa24-6934-4519-862f-16d01e5eaaf4",
"db_language_id": "0019d5c1-7b90-4cdb-a80b-a1a52aaa25fb",
"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-29T14:31:08.987161+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-29T14:31:08.987161+00:00"
},
"job_status_id": "1274da30-2461-49ce-b3af-e39ab0ef87dc",
"job_status_code": "sample string 11",
"db_address_id": "44b0c913-47d9-4ed1-9465-9685fa7e71c1",
"contact_id": "cf0e6f4e-fa72-4ff9-bca7-83c97b94a25b",
"requested_by_company_id": "531f4983-0a7c-4144-b8ea-fc2d2635ec68",
"requested_by_contact_id": "e2048ee7-59bf-4b04-94b4-64e83b9daa29",
"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-29T14:31:08.987161+00:00",
"due_date": "2026-08-29T14:31:08.987161+00:00",
"date_create": "2026-08-29T14:31:08.987161+00:00",
"date_update": "2026-08-29T14:31:08.987161+00:00",
"date_closed": "2026-08-29T14:31:08.987161+00:00",
"suggested_user_id": "afbd51e3-4abc-427f-95fd-f4e4ce4592b4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e0cfad00-43ba-406f-99b0-1492cf274112",
"db_language_id": "c0318f20-07c8-4010-b8fc-7b71a559589f",
"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-29T14:31:08.987161+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9acf66f9-242d-456e-bb35-d7366100d75f",
"sales_organization": {
"id": "c1e53b05-fd9e-4176-b217-1184ca80d1f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea3b5fbb-46c1-4b58-a768-e301a9e376a4",
"db_currency_id": "d697aa24-6934-4519-862f-16d01e5eaaf4",
"db_language_id": "0019d5c1-7b90-4cdb-a80b-a1a52aaa25fb",
"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-29T14:31:08.987161+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3b3f5f60-6910-4110-abdc-b3d8da9115c0",
"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": "783ef137-a6dc-47a6-8928-f152f6fca728",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-29T14:31:08.987161+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7448282b-95e0-4492-8814-fca9abee97f1"
},
"suggested_date_start": "2026-08-29T14:31:08.987161+00:00",
"skill_id": "f541b177-6dc1-42a6-a5d7-5634e5348622",
"skill_code": "sample string 32",
"skill": {
"id": "9715838c-7530-4899-b0e3-4e22e0f32837",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "031d70fa-c070-4517-b6b0-0c0c51bb8470",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c1e53b05-fd9e-4176-b217-1184ca80d1f7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ea3b5fbb-46c1-4b58-a768-e301a9e376a4",
"db_currency_id": "d697aa24-6934-4519-862f-16d01e5eaaf4",
"db_language_id": "0019d5c1-7b90-4cdb-a80b-a1a52aaa25fb",
"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-29T14:31:08.987161+00:00"
},
"modified_dateutc": "2026-08-29T14:31:08.987161+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "66e41742-5ccc-4c03-9f72-001615088844",
"date_reported_by_company": "2026-08-29T14:31:08.987161+00:00",
"id2": 36,
"company_id": "efe176a6-a630-4ce4-8406-f563da72237c",
"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": "4028f3fb-bf11-4754-aec3-4378590087ba",
"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-29T14:31:08.987161+00:00"
},
"work_instruction_details_id": "f42b3540-471e-4594-99cf-186687f3bb69",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cf790524-c275-403a-a3ec-b47f1145f457",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dad35a00-c03f-46fb-bd3f-7d90cb8ced29",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-29T14:31:08.987161+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": "cf0b6112-6b4b-45d4-9dc2-be5d598a8b74",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-29T14:31:08.987161+00:00"
}