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": "ca166dc8-e538-478a-a734-6f7299def4f3",
"jobs_id": "cad86699-e217-4f60-bd25-d9a39d257ba9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8058b547-0a69-452a-bb63-9adaf6c5cab1",
"_parent_id": "c1e0a5a1-3a94-417f-9794-cd26db147e19",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "068fa6e6-f2be-455c-b0f0-dc13cab6b98c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b1de0bf3-dd47-42b1-9b4a-93a294fc3699",
"_parent_id": "148aebda-e7b3-4cb4-a037-df44caabe45d",
"root_parent_id": "7955efc9-9fc6-468f-b96d-b3df86298d4b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f0d70397-4405-46a3-82a6-71ff3a741979",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "36ea84c6-95ac-42d1-993f-1529d5c8de67",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3866fb98-e37b-4f50-8813-9c26515a77e7",
"_parent_code": "sample string 6",
"sales_organization_id": "09b079ea-0a49-49e1-94d6-e2ac7bbc7af9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "40369da8-e0a9-4c69-a76d-56d33b1b4174",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f03425f-c433-488c-9980-b40986e6f848",
"db_currency_id": "a110cecd-4d08-4983-9dd9-5d47b126615a",
"db_language_id": "8bed88a8-bd91-49e2-9ab7-76aca9500689",
"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-10-26T16:27:57.2078305+00:00"
},
"modified_dateutc": "2026-10-26T16:27:57.2266825+00:00"
},
"equipment_model_id": "39c4dcdf-81c4-451c-9a69-ea70bc996605",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "26d3023d-724d-4852-95fd-cd9397afb240",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e130ecf6-9734-4618-bd0f-f68a635d283b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0a9d005b-9603-48d4-8e92-2196d0c40aa9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ac7c0481-0c95-49d5-9b89-f7d2c3677e3c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "40369da8-e0a9-4c69-a76d-56d33b1b4174",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f03425f-c433-488c-9980-b40986e6f848",
"db_currency_id": "a110cecd-4d08-4983-9dd9-5d47b126615a",
"db_language_id": "8bed88a8-bd91-49e2-9ab7-76aca9500689",
"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-10-26T16:27:57.2078305+00:00"
},
"modified_dateutc": "2026-10-26T16:27:57.2266825+00:00"
},
"equipment_family_id": "65d8427f-4a25-4fd2-8b07-9a151888a90a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "36ea84c6-95ac-42d1-993f-1529d5c8de67",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3866fb98-e37b-4f50-8813-9c26515a77e7",
"_parent_code": "sample string 6",
"sales_organization_id": "09b079ea-0a49-49e1-94d6-e2ac7bbc7af9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "40369da8-e0a9-4c69-a76d-56d33b1b4174",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f03425f-c433-488c-9980-b40986e6f848",
"db_currency_id": "a110cecd-4d08-4983-9dd9-5d47b126615a",
"db_language_id": "8bed88a8-bd91-49e2-9ab7-76aca9500689",
"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-10-26T16:27:57.2078305+00:00"
},
"modified_dateutc": "2026-10-26T16:27:57.2266825+00:00"
},
"date_in_production_since": "2026-10-26T16:27:57.2266825+00:00",
"date_out_of_production_since": "2026-10-26T16:27:57.2266825+00:00",
"date_end_support": "2026-10-26T16:27:57.2266825+00:00",
"sales_organization_id": "6cbc5ca1-607b-4b1e-9b57-cedd31811033",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "40369da8-e0a9-4c69-a76d-56d33b1b4174",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f03425f-c433-488c-9980-b40986e6f848",
"db_currency_id": "a110cecd-4d08-4983-9dd9-5d47b126615a",
"db_language_id": "8bed88a8-bd91-49e2-9ab7-76aca9500689",
"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-10-26T16:27:57.2078305+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-10-26T16:27:57.2390777+00:00"
},
"project_status_id": "0d173b83-e624-48aa-ac74-2770e8de6d04",
"project_status_code": "sample string 10",
"project_status": {
"id": "a16a09f3-a78b-4c98-9783-954b9bf473d8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9c856d5f-d3fa-40e5-9eb1-ed6c2bfb66f9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "40369da8-e0a9-4c69-a76d-56d33b1b4174",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f03425f-c433-488c-9980-b40986e6f848",
"db_currency_id": "a110cecd-4d08-4983-9dd9-5d47b126615a",
"db_language_id": "8bed88a8-bd91-49e2-9ab7-76aca9500689",
"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-10-26T16:27:57.2078305+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-26T16:27:57.2390777+00:00"
},
"company_id": "af3ae11d-b333-4113-816e-246b2d0b7478",
"company_code": "sample string 12",
"db_address_id": "568e8642-e414-4c5c-85ae-cd3a20e6710d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "18c76b92-576d-49f5-bfdc-4e223e6a890d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "44e9318d-84ba-485a-a94d-a57d3742b926",
"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-10-26T16:27:57.2390777+00:00",
"date_create": "2026-10-26T16:27:57.2390777+00:00",
"date_update": "2026-10-26T16:27:57.2390777+00:00",
"updated_by_user_id": "dbdd9158-8f65-480e-8dbe-d1adb82cac18",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-26T16:27:57.2390777+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-10-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-26T16:27:57.2390777+00:00",
"date_last_job": "2026-10-26T16:27:57.2390777+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-26T16:27:57.2390777+00:00",
"modified_dateutc": "2026-10-26T16:27:57.2390777+00:00",
"is_mobile_installation": true
},
"job_type_id": "f791056a-dc16-406a-b568-332bb24696cf",
"job_type_code": "sample string 7",
"job_type": {
"id": "f83cce45-06da-4c91-b244-0cb1bf04a057",
"name": "sample string 2",
"sales_organization_id": "d8a72a7f-62b0-4b36-bbd5-8546a7e11885",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-26T16:27:57.2390777+00:00",
"code": "sample string 7"
},
"job_priority_id": "46ee333c-ebf8-45b5-8888-4425a6474bbb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b0f39fdd-d76f-4546-a108-f74c1bd68725",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a9a1209c-ac69-48d4-b23d-e443ae2fdd69",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "40369da8-e0a9-4c69-a76d-56d33b1b4174",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f03425f-c433-488c-9980-b40986e6f848",
"db_currency_id": "a110cecd-4d08-4983-9dd9-5d47b126615a",
"db_language_id": "8bed88a8-bd91-49e2-9ab7-76aca9500689",
"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-10-26T16:27:57.2078305+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-26T16:27:57.2390777+00:00"
},
"job_status_id": "905bd235-a5fa-4440-b91c-e84bc670a1aa",
"job_status_code": "sample string 11",
"db_address_id": "daebd151-74db-4a00-b34e-b0c136a267e8",
"contact_id": "d5fa001a-1d23-424b-9915-b09d474debc1",
"requested_by_company_id": "6505c7d6-fbac-4b6e-be07-a9278a0a802c",
"requested_by_contact_id": "b5a4278f-35a4-4e98-a7ec-f7fc81947f7a",
"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-10-26T16:27:57.2390777+00:00",
"due_date": "2026-10-26T16:27:57.2390777+00:00",
"date_create": "2026-10-26T16:27:57.2390777+00:00",
"date_update": "2026-10-26T16:27:57.2390777+00:00",
"date_closed": "2026-10-26T16:27:57.2390777+00:00",
"suggested_user_id": "a46558fe-33b3-4cc5-b1b5-b1a1e2bcbe91",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f50b6c3a-69c0-4579-9139-264f9d5613eb",
"db_language_id": "b001c9fa-5713-410d-be60-936b721b0736",
"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-10-26T16:27:57.2390777+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "97056683-89ae-4f38-a45c-46e778608545",
"sales_organization": {
"id": "40369da8-e0a9-4c69-a76d-56d33b1b4174",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f03425f-c433-488c-9980-b40986e6f848",
"db_currency_id": "a110cecd-4d08-4983-9dd9-5d47b126615a",
"db_language_id": "8bed88a8-bd91-49e2-9ab7-76aca9500689",
"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-10-26T16:27:57.2078305+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ff90db24-b28b-4d0a-ab9b-8d53927a6202",
"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": "7ebcfc52-4f4a-4a91-8654-eb035c687ef0",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-26T16:27:57.2565568+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "49749648-f9c7-4707-b40c-965b57934023"
},
"suggested_date_start": "2026-10-26T16:27:57.2565568+00:00",
"skill_id": "3ea9ceec-f1a6-450d-9171-fcd1ddd1a2bf",
"skill_code": "sample string 32",
"skill": {
"id": "009c8eb5-4814-474e-815b-599a9146cb96",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "f57995c7-2fd3-4339-a282-14ead0f6ebcf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "40369da8-e0a9-4c69-a76d-56d33b1b4174",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f03425f-c433-488c-9980-b40986e6f848",
"db_currency_id": "a110cecd-4d08-4983-9dd9-5d47b126615a",
"db_language_id": "8bed88a8-bd91-49e2-9ab7-76aca9500689",
"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-10-26T16:27:57.2078305+00:00"
},
"modified_dateutc": "2026-10-26T16:27:57.2565568+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0522284f-7260-4a39-a011-b6d63c431112",
"date_reported_by_company": "2026-10-26T16:27:57.2565568+00:00",
"id2": 36,
"company_id": "cc8a8344-5af7-49ec-94e2-a3a89000bf88",
"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": "1b39a94e-0056-4d70-9491-58e1cc916669",
"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-10-26T16:27:57.2565568+00:00"
},
"work_instruction_details_id": "29324da6-ec58-4524-99f3-6af4a20769b4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a9015030-c4b0-40ec-ae0f-a0e5921c7287",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cb4e1aa6-7731-49d3-8aca-eecb8d251ea2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-26T16:27:57.2565568+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": "917be11d-0817-472e-ae40-2c1f55f5aa20",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-26T16:27:57.2565568+00:00"
}