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": "71f1b421-a504-484d-b2f5-2c921dd0b083",
"jobs_id": "8d0691cf-b2f8-459c-9598-ce8a0d44b052",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "46626de5-9797-4b47-8dc3-b24e7703c0dc",
"_parent_id": "7a461114-0a31-498d-8feb-acdff66cc963",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "790c9fce-300c-4ff2-8642-d41a49c79812",
"project_reference_back_office": "sample string 5",
"project": {
"id": "92942c96-179b-4dba-817b-ea37061f9cf3",
"_parent_id": "2adf08b3-e259-4753-a2fd-91ab129ab5ee",
"root_parent_id": "f60762be-8052-4c9f-b428-90388086de84",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6afa9956-5851-41f1-b67f-2aeb3a7b9e99",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "649eba9b-aae3-4909-9f7a-e305a2dd47d6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "28855a70-9376-460d-89c2-c9defa42ab0d",
"_parent_code": "sample string 6",
"sales_organization_id": "4da90815-3dac-47b9-ac84-9a2f66cec50f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ff6e40e6-caed-42e7-8255-ed998d8a35ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "370c8b0a-babe-452c-9da8-dbd89cf4d394",
"db_currency_id": "f501ff0a-a0a4-428a-a89c-538ef2e8c660",
"db_language_id": "bbafe32c-9679-46c1-95a6-eb9cfbe9b92e",
"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": "2025-12-26T05:53:55.6943384+00:00"
},
"modified_dateutc": "2025-12-26T05:53:55.6943384+00:00"
},
"equipment_model_id": "b5466361-1a09-4e57-9b29-cfdc391bdf3c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "cdfebbaf-2b83-40f1-9d1a-fd5c68837586",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3982b103-7e72-481e-b1df-de4f4f28592e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ddfbfae4-3f6b-47ce-b9f1-a3f0e5ca1a4e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "95c05631-ba53-4fc4-be85-bf241b522f95",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ff6e40e6-caed-42e7-8255-ed998d8a35ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "370c8b0a-babe-452c-9da8-dbd89cf4d394",
"db_currency_id": "f501ff0a-a0a4-428a-a89c-538ef2e8c660",
"db_language_id": "bbafe32c-9679-46c1-95a6-eb9cfbe9b92e",
"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": "2025-12-26T05:53:55.6943384+00:00"
},
"modified_dateutc": "2025-12-26T05:53:55.6943384+00:00"
},
"equipment_family_id": "39aee08d-7f47-4e92-8502-0c2a160685bc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "649eba9b-aae3-4909-9f7a-e305a2dd47d6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "28855a70-9376-460d-89c2-c9defa42ab0d",
"_parent_code": "sample string 6",
"sales_organization_id": "4da90815-3dac-47b9-ac84-9a2f66cec50f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ff6e40e6-caed-42e7-8255-ed998d8a35ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "370c8b0a-babe-452c-9da8-dbd89cf4d394",
"db_currency_id": "f501ff0a-a0a4-428a-a89c-538ef2e8c660",
"db_language_id": "bbafe32c-9679-46c1-95a6-eb9cfbe9b92e",
"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": "2025-12-26T05:53:55.6943384+00:00"
},
"modified_dateutc": "2025-12-26T05:53:55.6943384+00:00"
},
"date_in_production_since": "2025-12-26T05:53:55.6943384+00:00",
"date_out_of_production_since": "2025-12-26T05:53:55.6943384+00:00",
"date_end_support": "2025-12-26T05:53:55.6943384+00:00",
"sales_organization_id": "2fc0b2d2-e67a-4bcc-8aa5-46c0cd79fc8d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ff6e40e6-caed-42e7-8255-ed998d8a35ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "370c8b0a-babe-452c-9da8-dbd89cf4d394",
"db_currency_id": "f501ff0a-a0a4-428a-a89c-538ef2e8c660",
"db_language_id": "bbafe32c-9679-46c1-95a6-eb9cfbe9b92e",
"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": "2025-12-26T05:53:55.6943384+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": "2025-12-26T05:53:55.6943384+00:00"
},
"project_status_id": "11bb2510-6864-4bb2-93a7-068fdc7e743e",
"project_status_code": "sample string 10",
"project_status": {
"id": "5f923d25-ad8d-4eb9-a70a-f8b93ff9256a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "653adbf4-9a8f-4d36-992f-d97abc011f27",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ff6e40e6-caed-42e7-8255-ed998d8a35ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "370c8b0a-babe-452c-9da8-dbd89cf4d394",
"db_currency_id": "f501ff0a-a0a4-428a-a89c-538ef2e8c660",
"db_language_id": "bbafe32c-9679-46c1-95a6-eb9cfbe9b92e",
"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": "2025-12-26T05:53:55.6943384+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-26T05:53:55.6943384+00:00"
},
"company_id": "295a4a24-5564-4609-81c0-d98aba14b96e",
"company_code": "sample string 12",
"db_address_id": "cd1b9101-8915-488c-b289-0a30e87cbcd2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e5d49046-ce9a-4e8d-bd04-9e5b94d640c2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3ee3f062-97b7-4d9a-be06-245dc82efbd8",
"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": "2025-12-26T05:53:55.6943384+00:00",
"date_create": "2025-12-26T05:53:55.6943384+00:00",
"date_update": "2025-12-26T05:53:55.6943384+00:00",
"updated_by_user_id": "808781a4-5f99-4e6c-9c49-67b05aeb072b",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-26T05:53:55.6943384+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": "2025-12-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-26T05:53:55.6943384+00:00",
"date_last_job": "2025-12-26T05:53:55.6943384+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-26T05:53:55.6943384+00:00",
"modified_dateutc": "2025-12-26T05:53:55.6943384+00:00",
"is_mobile_installation": true
},
"job_type_id": "2ced5a14-0b79-4d2c-9089-aaab058247bb",
"job_type_code": "sample string 7",
"job_type": {
"id": "d726b53f-8f77-4e8b-8a6e-386b8e101bc7",
"name": "sample string 2",
"sales_organization_id": "39b74312-ee9d-4c0b-a464-8232198a2c4d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-26T05:53:55.6943384+00:00",
"code": "sample string 7"
},
"job_priority_id": "938f3db4-d074-4e48-bfe3-521b151fa222",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0d52e3e1-b0c3-45cd-847a-57d5e088ab1b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8e2f78eb-563f-4fc8-b24c-adc7b28fd0bc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ff6e40e6-caed-42e7-8255-ed998d8a35ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "370c8b0a-babe-452c-9da8-dbd89cf4d394",
"db_currency_id": "f501ff0a-a0a4-428a-a89c-538ef2e8c660",
"db_language_id": "bbafe32c-9679-46c1-95a6-eb9cfbe9b92e",
"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": "2025-12-26T05:53:55.6943384+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-26T05:53:55.6943384+00:00"
},
"job_status_id": "fccfc0dc-d2ce-454b-ba8c-3db1a9ebbe33",
"job_status_code": "sample string 11",
"db_address_id": "4772c6c3-1de6-43be-9a56-05843cccfcab",
"contact_id": "f43704dc-b28b-4df7-827f-bc30acc7373a",
"requested_by_company_id": "7daf8234-174d-4149-8083-7c971cdc8673",
"requested_by_contact_id": "edc700b0-e64a-4187-bd9a-9609fd880287",
"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": "2025-12-26T05:53:55.7099642+00:00",
"due_date": "2025-12-26T05:53:55.7099642+00:00",
"date_create": "2025-12-26T05:53:55.7099642+00:00",
"date_update": "2025-12-26T05:53:55.7099642+00:00",
"date_closed": "2025-12-26T05:53:55.7099642+00:00",
"suggested_user_id": "b9fa29e6-ba10-4bbd-bb71-e3cb00655ad4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9dc1596e-6e05-4b6e-a589-4ff08fe47c75",
"db_language_id": "a1b86973-d5ff-4d10-873f-c215b1a5bf26",
"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": "2025-12-26T05:53:55.7099642+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f765d37e-223c-400f-b33b-fa613930176d",
"sales_organization": {
"id": "ff6e40e6-caed-42e7-8255-ed998d8a35ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "370c8b0a-babe-452c-9da8-dbd89cf4d394",
"db_currency_id": "f501ff0a-a0a4-428a-a89c-538ef2e8c660",
"db_language_id": "bbafe32c-9679-46c1-95a6-eb9cfbe9b92e",
"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": "2025-12-26T05:53:55.6943384+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c63ab53c-9b12-477b-ae2c-4d8e8e746e00",
"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": "1ac8a0f1-47c4-4166-b354-8e66d4f0e33e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-26T05:53:55.7099642+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6bf6f6fa-f1a2-483f-9df4-2cb724804289"
},
"suggested_date_start": "2025-12-26T05:53:55.7099642+00:00",
"skill_id": "2dbda6ad-ae1c-44b3-af90-0a2d8258b57c",
"skill_code": "sample string 32",
"skill": {
"id": "b224c0e2-3c6a-4980-80a6-72cbe98bb993",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2133cbaf-e91d-4716-9b31-cf2adc8ca354",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ff6e40e6-caed-42e7-8255-ed998d8a35ac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "370c8b0a-babe-452c-9da8-dbd89cf4d394",
"db_currency_id": "f501ff0a-a0a4-428a-a89c-538ef2e8c660",
"db_language_id": "bbafe32c-9679-46c1-95a6-eb9cfbe9b92e",
"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": "2025-12-26T05:53:55.6943384+00:00"
},
"modified_dateutc": "2025-12-26T05:53:55.7099642+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "eaef4dd4-9f8a-4a75-ba8c-d235498764ad",
"date_reported_by_company": "2025-12-26T05:53:55.7099642+00:00",
"id2": 36,
"company_id": "c4d6831a-6acd-48cf-8ae2-673369d0cd70",
"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": "e2377546-cada-4c2b-92a3-ba17b9d691d5",
"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": "2025-12-26T05:53:55.7099642+00:00"
},
"work_instruction_details_id": "d7fd9b86-5ee5-4020-b651-fc3aed8ea324",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3cc40363-27c6-4a7b-a4e2-d1771efe10b6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a425cceb-ac61-44c7-9c85-69824f315287",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-26T05:53:55.7099642+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": "a5a83291-de65-440d-8121-2a4e6e5be871",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-26T05:53:55.7099642+00:00"
}