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": "4dd91bd0-ec0e-4b4a-9e95-d5fcbe9cd7f2",
"jobs_id": "c0c023df-58b4-43b9-bde0-e0c244a577d8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f663d650-6c12-41a7-afd6-48ca39fe2a5f",
"_parent_id": "064a365b-98f0-4339-a943-ac1a21a21403",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9b0c3f22-c5a3-4a35-9e77-833726896f5d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f3745247-ae1b-4553-9544-c833b2d0d6ba",
"_parent_id": "13ffc158-8429-4e8c-b675-3d3136a5baea",
"root_parent_id": "b9e88ee6-64e5-4e4c-bfac-c0f8acc7363d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "25761975-63a8-4c26-b226-4784501b936b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5f91189e-2fc6-47e7-b847-99756d09fa72",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a349081e-c678-49aa-85b4-60219b2f0fe6",
"_parent_code": "sample string 6",
"sales_organization_id": "421c707b-003e-46d2-9a4f-7a2c69c4e17d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d1c1e8cd-f2aa-454d-9c7d-1978bb978436",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5272cd9-c2e0-431a-94de-31fd4ab5484b",
"db_currency_id": "ee25432b-4493-4e5e-8860-52564bb83711",
"db_language_id": "2b726368-db73-4457-986c-e390f964dfd2",
"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-05-12T10:09:16.0706038+00:00"
},
"modified_dateutc": "2026-05-12T10:09:16.0706038+00:00"
},
"equipment_model_id": "beef13ef-7354-4ce1-ad57-8eec314f13cf",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "30f141ca-c7f7-4206-be44-f3ed82644938",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "096926a6-cc26-4c6f-afb9-30ddfd7347c4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d84cf354-c19c-40f1-b576-bea4456df7b6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "85dcd5d9-a58e-42a6-a48e-6804dc3e9a99",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d1c1e8cd-f2aa-454d-9c7d-1978bb978436",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5272cd9-c2e0-431a-94de-31fd4ab5484b",
"db_currency_id": "ee25432b-4493-4e5e-8860-52564bb83711",
"db_language_id": "2b726368-db73-4457-986c-e390f964dfd2",
"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-05-12T10:09:16.0706038+00:00"
},
"modified_dateutc": "2026-05-12T10:09:16.0706038+00:00"
},
"equipment_family_id": "71d5b4bc-2fbd-43f7-92a7-8f5e79387edb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5f91189e-2fc6-47e7-b847-99756d09fa72",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a349081e-c678-49aa-85b4-60219b2f0fe6",
"_parent_code": "sample string 6",
"sales_organization_id": "421c707b-003e-46d2-9a4f-7a2c69c4e17d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d1c1e8cd-f2aa-454d-9c7d-1978bb978436",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5272cd9-c2e0-431a-94de-31fd4ab5484b",
"db_currency_id": "ee25432b-4493-4e5e-8860-52564bb83711",
"db_language_id": "2b726368-db73-4457-986c-e390f964dfd2",
"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-05-12T10:09:16.0706038+00:00"
},
"modified_dateutc": "2026-05-12T10:09:16.0706038+00:00"
},
"date_in_production_since": "2026-05-12T10:09:16.0706038+00:00",
"date_out_of_production_since": "2026-05-12T10:09:16.0706038+00:00",
"date_end_support": "2026-05-12T10:09:16.0706038+00:00",
"sales_organization_id": "6106b702-393e-4df0-a65e-393293abd1aa",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d1c1e8cd-f2aa-454d-9c7d-1978bb978436",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5272cd9-c2e0-431a-94de-31fd4ab5484b",
"db_currency_id": "ee25432b-4493-4e5e-8860-52564bb83711",
"db_language_id": "2b726368-db73-4457-986c-e390f964dfd2",
"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-05-12T10:09:16.0706038+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-05-12T10:09:16.0706038+00:00"
},
"project_status_id": "16398fda-99ae-4735-8e72-6470e6a22d6e",
"project_status_code": "sample string 10",
"project_status": {
"id": "1572bd4b-b031-46cf-ba90-bd7c02a0d65b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f0af2865-7886-4ec8-a79d-d8147ae231e3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d1c1e8cd-f2aa-454d-9c7d-1978bb978436",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5272cd9-c2e0-431a-94de-31fd4ab5484b",
"db_currency_id": "ee25432b-4493-4e5e-8860-52564bb83711",
"db_language_id": "2b726368-db73-4457-986c-e390f964dfd2",
"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-05-12T10:09:16.0706038+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-12T10:09:16.0706038+00:00"
},
"company_id": "f0c690da-9af4-418b-b9ad-46ec9e6a1f61",
"company_code": "sample string 12",
"db_address_id": "d151e7c9-dcc7-45a9-a180-89c7697bdc48",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4b87c4f9-58a2-4ad2-a022-faa7437b55f5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "fc4629f4-42ed-4db0-b9a3-041cf86b3fac",
"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-05-12T10:09:16.0706038+00:00",
"date_create": "2026-05-12T10:09:16.0706038+00:00",
"date_update": "2026-05-12T10:09:16.0706038+00:00",
"updated_by_user_id": "ac3fb3b0-6f98-4767-ac33-610a1f3bd8cf",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-12T10:09:16.0706038+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-05-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-12T10:09:16.0706038+00:00",
"date_last_job": "2026-05-12T10:09:16.0706038+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-12T10:09:16.0706038+00:00",
"modified_dateutc": "2026-05-12T10:09:16.0706038+00:00",
"is_mobile_installation": true
},
"job_type_id": "4561138f-40aa-4e2e-a064-cbb9c6217a0e",
"job_type_code": "sample string 7",
"job_type": {
"id": "434cb533-f63d-4464-aa74-231efb5e4292",
"name": "sample string 2",
"sales_organization_id": "b6a11821-1dde-4868-bd6b-96aebccdff6c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-12T10:09:16.0706038+00:00",
"code": "sample string 7"
},
"job_priority_id": "f6d8b1b0-1734-4a40-8097-82fd316eb3fc",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bbc5a2a8-8b96-43df-a6db-23dd1d3f1cd7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e1256797-18c7-44c3-ad49-011a630b4af2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d1c1e8cd-f2aa-454d-9c7d-1978bb978436",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5272cd9-c2e0-431a-94de-31fd4ab5484b",
"db_currency_id": "ee25432b-4493-4e5e-8860-52564bb83711",
"db_language_id": "2b726368-db73-4457-986c-e390f964dfd2",
"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-05-12T10:09:16.0706038+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-12T10:09:16.0706038+00:00"
},
"job_status_id": "91723be6-0e3b-4c81-b2e7-ea3cd2caaa42",
"job_status_code": "sample string 11",
"db_address_id": "b401c020-99d1-4f49-ac9e-515990899532",
"contact_id": "9164386c-eeab-4c4d-a249-395bab11569c",
"requested_by_company_id": "ec1066e4-8d4e-40ee-8929-30fbaa68fa95",
"requested_by_contact_id": "8a040dd6-22ae-4613-9f64-2a3a6796ee6b",
"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-05-12T10:09:16.0706038+00:00",
"due_date": "2026-05-12T10:09:16.0706038+00:00",
"date_create": "2026-05-12T10:09:16.0706038+00:00",
"date_update": "2026-05-12T10:09:16.0706038+00:00",
"date_closed": "2026-05-12T10:09:16.0706038+00:00",
"suggested_user_id": "fecc5f9e-5d93-4ad3-aef6-a21f7681705e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a19f527a-9c69-476b-aded-a8d130cea461",
"db_language_id": "d60c3680-cf41-4784-8bba-d0e71ec5264e",
"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-05-12T10:09:16.0706038+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "58eb108f-f26b-4e15-a96c-8a9e8849f527",
"sales_organization": {
"id": "d1c1e8cd-f2aa-454d-9c7d-1978bb978436",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5272cd9-c2e0-431a-94de-31fd4ab5484b",
"db_currency_id": "ee25432b-4493-4e5e-8860-52564bb83711",
"db_language_id": "2b726368-db73-4457-986c-e390f964dfd2",
"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-05-12T10:09:16.0706038+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "188e7284-a6e2-4fcb-9edc-860258cc03d2",
"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": "ee882fd6-1179-4648-8e73-1ea8270f47fd",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-12T10:09:16.0706038+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b427321b-3cc6-4554-bfaa-ac000fdd2ebb"
},
"suggested_date_start": "2026-05-12T10:09:16.0706038+00:00",
"skill_id": "44bf6767-f54e-4697-8210-a8bea1f70df8",
"skill_code": "sample string 32",
"skill": {
"id": "3718fb29-9e8c-4b1c-9da9-93d35b666380",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7fe242d3-2124-4437-ba12-0b4c4df17003",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d1c1e8cd-f2aa-454d-9c7d-1978bb978436",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d5272cd9-c2e0-431a-94de-31fd4ab5484b",
"db_currency_id": "ee25432b-4493-4e5e-8860-52564bb83711",
"db_language_id": "2b726368-db73-4457-986c-e390f964dfd2",
"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-05-12T10:09:16.0706038+00:00"
},
"modified_dateutc": "2026-05-12T10:09:16.0706038+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "51dbdff1-c709-4e70-8eb4-a35ec8f7e39c",
"date_reported_by_company": "2026-05-12T10:09:16.0706038+00:00",
"id2": 36,
"company_id": "23b91989-006b-4fad-a41e-13920afa606f",
"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": "0b7d138f-0df2-487b-9ea5-3bbac2189ecb",
"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-05-12T10:09:16.0706038+00:00"
},
"work_instruction_details_id": "eeea2182-e134-4948-b3a3-022b63ef5a29",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "855a4e14-7850-4926-9603-b2b7717658ba",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3e40b148-b233-49fa-b082-d694e92c53eb",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-12T10:09:16.0706038+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": "b8ee1f71-36fb-4671-af9f-e413f49ecebd",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-12T10:09:16.0706038+00:00"
}