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": "6dd1c68b-1c39-49f3-bf60-f8744dedddde",
"jobs_id": "03ef90a5-d8df-4939-8e57-3ab089629f29",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c19dbd24-9046-454a-ac04-13835f165ce5",
"_parent_id": "ea207cd0-925f-4c2a-9542-3e2e3d974d6d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2ccce172-3f23-4f04-9d71-451b42da3f2b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "54c92b4b-0b77-4c6d-b9f5-f0f231c574af",
"_parent_id": "4c9130b8-0480-4d76-b17c-a3b6f5bf2362",
"root_parent_id": "8baff893-e27f-4eb0-83cd-9852dbbcc65e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "017b921d-fe3c-466a-8209-5b4cc567f8cc",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "33802728-9f02-432e-b8f2-9b4700aec263",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9b28b789-32f8-4f66-bd5d-9a4e002019e8",
"_parent_code": "sample string 6",
"sales_organization_id": "4967d8b8-e5f4-4457-865b-b25110ddd9c8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a31cc806-0dad-46a0-b39f-44f01b8f0a14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d026b68-a45d-4156-9aae-89bd5ea2ec22",
"db_currency_id": "3867d969-97ad-40cf-a55d-85eb8ba9fdfd",
"db_language_id": "d09a0f48-0ffe-4a19-9383-ac6eddfd417a",
"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-07T23:52:44.174863+00:00"
},
"modified_dateutc": "2026-05-07T23:52:44.174863+00:00"
},
"equipment_model_id": "e205e84b-cada-42e0-8b7a-10353bb964a3",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b13b5856-aedf-4bb6-a596-d95f93603d61",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "33ee201c-e9ca-42f1-82b8-54cc90270bad",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c911b2a4-c721-45d1-b564-1eb5ed9afb86",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f0bad0dd-1dcb-4cb1-b4e4-78db8150370f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a31cc806-0dad-46a0-b39f-44f01b8f0a14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d026b68-a45d-4156-9aae-89bd5ea2ec22",
"db_currency_id": "3867d969-97ad-40cf-a55d-85eb8ba9fdfd",
"db_language_id": "d09a0f48-0ffe-4a19-9383-ac6eddfd417a",
"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-07T23:52:44.174863+00:00"
},
"modified_dateutc": "2026-05-07T23:52:44.174863+00:00"
},
"equipment_family_id": "9c44300c-82fc-4f93-88b3-8ae1e180ce91",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "33802728-9f02-432e-b8f2-9b4700aec263",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9b28b789-32f8-4f66-bd5d-9a4e002019e8",
"_parent_code": "sample string 6",
"sales_organization_id": "4967d8b8-e5f4-4457-865b-b25110ddd9c8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a31cc806-0dad-46a0-b39f-44f01b8f0a14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d026b68-a45d-4156-9aae-89bd5ea2ec22",
"db_currency_id": "3867d969-97ad-40cf-a55d-85eb8ba9fdfd",
"db_language_id": "d09a0f48-0ffe-4a19-9383-ac6eddfd417a",
"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-07T23:52:44.174863+00:00"
},
"modified_dateutc": "2026-05-07T23:52:44.174863+00:00"
},
"date_in_production_since": "2026-05-07T23:52:44.174863+00:00",
"date_out_of_production_since": "2026-05-07T23:52:44.174863+00:00",
"date_end_support": "2026-05-07T23:52:44.174863+00:00",
"sales_organization_id": "e53677b1-99f4-4104-b7f5-db6ccf5f87ee",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a31cc806-0dad-46a0-b39f-44f01b8f0a14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d026b68-a45d-4156-9aae-89bd5ea2ec22",
"db_currency_id": "3867d969-97ad-40cf-a55d-85eb8ba9fdfd",
"db_language_id": "d09a0f48-0ffe-4a19-9383-ac6eddfd417a",
"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-07T23:52:44.174863+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-07T23:52:44.174863+00:00"
},
"project_status_id": "799936df-15e8-4d08-8a6d-84ddbfcfcd0b",
"project_status_code": "sample string 10",
"project_status": {
"id": "dddcd802-d118-4a81-ba44-db7eb99f0a82",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ad7da291-28cb-436c-90a4-e0b04cda9fc4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a31cc806-0dad-46a0-b39f-44f01b8f0a14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d026b68-a45d-4156-9aae-89bd5ea2ec22",
"db_currency_id": "3867d969-97ad-40cf-a55d-85eb8ba9fdfd",
"db_language_id": "d09a0f48-0ffe-4a19-9383-ac6eddfd417a",
"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-07T23:52:44.174863+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-07T23:52:44.174863+00:00"
},
"company_id": "705c4d83-35c2-4813-9e44-2ae3355f81a6",
"company_code": "sample string 12",
"db_address_id": "443ce08b-d855-4e43-ba74-e448d14fac9b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "08a0b322-3376-43c2-a710-6521de10e148",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "15c504a2-a515-45e2-a5be-8b58465f38d4",
"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-07T23:52:44.174863+00:00",
"date_create": "2026-05-07T23:52:44.174863+00:00",
"date_update": "2026-05-07T23:52:44.174863+00:00",
"updated_by_user_id": "9cbc5616-190a-485b-b67e-d6475ca88950",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-07T23:52:44.174863+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-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-07T23:52:44.174863+00:00",
"date_last_job": "2026-05-07T23:52:44.174863+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-07T23:52:44.174863+00:00",
"modified_dateutc": "2026-05-07T23:52:44.174863+00:00",
"is_mobile_installation": true
},
"job_type_id": "ef4a2f5b-bbec-4fd6-8070-f022c2318bac",
"job_type_code": "sample string 7",
"job_type": {
"id": "7e15e77e-d9dd-4858-8840-87d5b1b7c7f6",
"name": "sample string 2",
"sales_organization_id": "53098bf2-8867-4e5d-8e39-ceab4a201d6e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-07T23:52:44.174863+00:00",
"code": "sample string 7"
},
"job_priority_id": "b49c0f0d-8719-4a35-bfb5-0d3517fb6718",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0bf5a4dc-65d4-4ea9-bd0d-e5760beeb40e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6a7e07b4-9748-42a7-a226-ca083795d84a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a31cc806-0dad-46a0-b39f-44f01b8f0a14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d026b68-a45d-4156-9aae-89bd5ea2ec22",
"db_currency_id": "3867d969-97ad-40cf-a55d-85eb8ba9fdfd",
"db_language_id": "d09a0f48-0ffe-4a19-9383-ac6eddfd417a",
"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-07T23:52:44.174863+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-07T23:52:44.174863+00:00"
},
"job_status_id": "ed1ba45d-a117-40b7-a06f-e31e4e258468",
"job_status_code": "sample string 11",
"db_address_id": "d37e39ad-117b-4d97-a84d-3fec31259fa4",
"contact_id": "2c30e5d1-d67f-42f0-aaa8-a1e659866bbd",
"requested_by_company_id": "79eda585-cd6a-421c-a77c-a37632d1698b",
"requested_by_contact_id": "c1803271-7b39-4261-87cc-6d5cd64b6c58",
"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-07T23:52:44.174863+00:00",
"due_date": "2026-05-07T23:52:44.174863+00:00",
"date_create": "2026-05-07T23:52:44.174863+00:00",
"date_update": "2026-05-07T23:52:44.174863+00:00",
"date_closed": "2026-05-07T23:52:44.174863+00:00",
"suggested_user_id": "e0dfe8a8-ef60-4dbe-a7dd-e88eab7f5c41",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5805daf2-4543-4704-84f1-f596de4d33c9",
"db_language_id": "eec6a6b4-5556-4048-aa61-2edf1f68626c",
"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-07T23:52:44.174863+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9ea720d3-4265-4f96-a3ae-c23328967bae",
"sales_organization": {
"id": "a31cc806-0dad-46a0-b39f-44f01b8f0a14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d026b68-a45d-4156-9aae-89bd5ea2ec22",
"db_currency_id": "3867d969-97ad-40cf-a55d-85eb8ba9fdfd",
"db_language_id": "d09a0f48-0ffe-4a19-9383-ac6eddfd417a",
"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-07T23:52:44.174863+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ec73e2fe-c4a9-4b5a-8b68-6b388c029301",
"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": "83f1359d-d601-4bbc-b0b8-ff7eb118f6e7",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-07T23:52:44.174863+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "cf7979e3-9697-4ed0-9b90-02cdebe643a0"
},
"suggested_date_start": "2026-05-07T23:52:44.174863+00:00",
"skill_id": "06779410-36a4-4b3f-9f34-043d3df23440",
"skill_code": "sample string 32",
"skill": {
"id": "c5d677fb-8491-4098-99c1-354becd262e3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "da4505ad-fa4d-48fb-86d0-1d31c4e2faa3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a31cc806-0dad-46a0-b39f-44f01b8f0a14",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9d026b68-a45d-4156-9aae-89bd5ea2ec22",
"db_currency_id": "3867d969-97ad-40cf-a55d-85eb8ba9fdfd",
"db_language_id": "d09a0f48-0ffe-4a19-9383-ac6eddfd417a",
"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-07T23:52:44.174863+00:00"
},
"modified_dateutc": "2026-05-07T23:52:44.174863+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "28aed865-46e6-49f2-a781-56bfdd8de81e",
"date_reported_by_company": "2026-05-07T23:52:44.174863+00:00",
"id2": 36,
"company_id": "e59ea601-5188-4362-8d83-590e2b374da4",
"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": "7e958773-d3a3-4321-91c7-9457e5b3cf83",
"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-07T23:52:44.174863+00:00"
},
"work_instruction_details_id": "853acfcf-7b86-4d67-af20-c535b53d1101",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "06a856f2-3771-410d-88db-4cc0cecb9e4d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5c8cdb1b-a40c-4ba6-aec3-9cfe50863656",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-07T23:52:44.174863+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": "d0eb0d38-e512-4be2-aee6-09d952a34cc4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-07T23:52:44.174863+00:00"
}