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": "8dd2e80d-25f7-4663-9a23-877adb8ead37",
"jobs_id": "667f63b5-4ed7-4cf9-98dc-a73227356ee9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e3a587ea-4c2b-43f1-9fb3-8186449aa410",
"_parent_id": "c90759b1-a00d-46f3-9e36-d73a1cd48262",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "caa3f201-2b2d-4adb-827c-6a0464831a46",
"project_reference_back_office": "sample string 5",
"project": {
"id": "38f59ed3-4f22-49f6-8a86-3138ead9ca73",
"_parent_id": "f16a9b57-ab28-430a-80d7-64260630c523",
"root_parent_id": "342603f6-aa2f-4ba6-981e-90869b19ca44",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f4480711-f99f-4b66-b811-65fab84a3ccb",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2282e19f-d675-415b-80ab-f9f8a0d5fb15",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "46446481-ecb4-45b6-a81b-0eebe7e632b3",
"_parent_code": "sample string 6",
"sales_organization_id": "8d011f64-4edd-4a71-ac26-16ab31769391",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8e51add0-b66f-4e9a-a97d-980ae6d9ae32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "510bbbfd-8b0e-4393-a86c-08b374ba898a",
"db_currency_id": "9cc77dca-4bfc-4100-b704-250275780bd0",
"db_language_id": "70b74c01-10de-4f4d-be3d-dc1b0300958f",
"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-09-08T00:06:52.3894636+00:00"
},
"modified_dateutc": "2026-09-08T00:06:52.3894636+00:00"
},
"equipment_model_id": "59c5d402-72f7-4180-b11f-e0f7c2a23ada",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0c80add8-9871-4b15-92aa-60a00ebfbf17",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7cd432e2-08d2-447f-9cda-226db175bd5d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "87873fd5-eb0d-4f5b-9e36-25925044d87e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "aecddc12-e7ec-489b-b06c-bd0d94baf45f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8e51add0-b66f-4e9a-a97d-980ae6d9ae32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "510bbbfd-8b0e-4393-a86c-08b374ba898a",
"db_currency_id": "9cc77dca-4bfc-4100-b704-250275780bd0",
"db_language_id": "70b74c01-10de-4f4d-be3d-dc1b0300958f",
"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-09-08T00:06:52.3894636+00:00"
},
"modified_dateutc": "2026-09-08T00:06:52.3894636+00:00"
},
"equipment_family_id": "814a72c9-1f0d-4bb5-81ea-04c2ddd04f08",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2282e19f-d675-415b-80ab-f9f8a0d5fb15",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "46446481-ecb4-45b6-a81b-0eebe7e632b3",
"_parent_code": "sample string 6",
"sales_organization_id": "8d011f64-4edd-4a71-ac26-16ab31769391",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8e51add0-b66f-4e9a-a97d-980ae6d9ae32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "510bbbfd-8b0e-4393-a86c-08b374ba898a",
"db_currency_id": "9cc77dca-4bfc-4100-b704-250275780bd0",
"db_language_id": "70b74c01-10de-4f4d-be3d-dc1b0300958f",
"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-09-08T00:06:52.3894636+00:00"
},
"modified_dateutc": "2026-09-08T00:06:52.3894636+00:00"
},
"date_in_production_since": "2026-09-08T00:06:52.3894636+00:00",
"date_out_of_production_since": "2026-09-08T00:06:52.3894636+00:00",
"date_end_support": "2026-09-08T00:06:52.3894636+00:00",
"sales_organization_id": "d305324d-dd99-4874-95fd-75508098eb23",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8e51add0-b66f-4e9a-a97d-980ae6d9ae32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "510bbbfd-8b0e-4393-a86c-08b374ba898a",
"db_currency_id": "9cc77dca-4bfc-4100-b704-250275780bd0",
"db_language_id": "70b74c01-10de-4f4d-be3d-dc1b0300958f",
"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-09-08T00:06:52.3894636+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-09-08T00:06:52.3894636+00:00"
},
"project_status_id": "83ffcb8c-b219-4472-823a-f57b2a118997",
"project_status_code": "sample string 10",
"project_status": {
"id": "17b3e6d5-2923-4a63-9cc6-46fb01fc80e8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0fd0a075-7c53-4631-bc8e-67c62ef8c4a4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8e51add0-b66f-4e9a-a97d-980ae6d9ae32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "510bbbfd-8b0e-4393-a86c-08b374ba898a",
"db_currency_id": "9cc77dca-4bfc-4100-b704-250275780bd0",
"db_language_id": "70b74c01-10de-4f4d-be3d-dc1b0300958f",
"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-09-08T00:06:52.3894636+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-08T00:06:52.3894636+00:00"
},
"company_id": "542b0294-437d-4d3f-ac71-e86813a230ba",
"company_code": "sample string 12",
"db_address_id": "b8ef3edc-0915-48b2-aed4-c5392fea7a46",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "644a4642-4c70-430a-8897-40c19e44943b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "10c61ac6-6d0f-452d-8624-6407fe945316",
"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-09-08T00:06:52.3894636+00:00",
"date_create": "2026-09-08T00:06:52.3894636+00:00",
"date_update": "2026-09-08T00:06:52.3894636+00:00",
"updated_by_user_id": "ba881d4e-012f-4243-8f0b-5526edda4b85",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-08T00:06:52.3894636+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-09-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-08T00:06:52.3894636+00:00",
"date_last_job": "2026-09-08T00:06:52.3894636+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-08T00:06:52.3894636+00:00",
"modified_dateutc": "2026-09-08T00:06:52.3894636+00:00",
"is_mobile_installation": true
},
"job_type_id": "7005b97f-8982-4dee-993a-756663d2ccbf",
"job_type_code": "sample string 7",
"job_type": {
"id": "d4c84b7f-74aa-4fbb-9c2d-a83d7156cc93",
"name": "sample string 2",
"sales_organization_id": "e0846128-edff-4c3c-bad2-909b410a0040",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-08T00:06:52.3894636+00:00",
"code": "sample string 7"
},
"job_priority_id": "2a6db31b-c763-437e-8c8c-fec50effe59e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "79724238-6de3-4966-8698-d7175f649409",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7536af5b-7a1f-4bc3-93f9-f8b533f98f06",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8e51add0-b66f-4e9a-a97d-980ae6d9ae32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "510bbbfd-8b0e-4393-a86c-08b374ba898a",
"db_currency_id": "9cc77dca-4bfc-4100-b704-250275780bd0",
"db_language_id": "70b74c01-10de-4f4d-be3d-dc1b0300958f",
"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-09-08T00:06:52.3894636+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-08T00:06:52.3894636+00:00"
},
"job_status_id": "440d39a0-9d8a-48af-ba2d-6d8acb5d66d1",
"job_status_code": "sample string 11",
"db_address_id": "8c620866-ca7c-4d37-ad44-d9d114a3242e",
"contact_id": "d4218212-1fe9-4fac-8857-5382377b4162",
"requested_by_company_id": "e476668f-41d2-4341-b733-462a4431b032",
"requested_by_contact_id": "a648c4a0-e38b-43ba-aec0-00cb491c942f",
"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-09-08T00:06:52.3894636+00:00",
"due_date": "2026-09-08T00:06:52.3894636+00:00",
"date_create": "2026-09-08T00:06:52.3894636+00:00",
"date_update": "2026-09-08T00:06:52.3894636+00:00",
"date_closed": "2026-09-08T00:06:52.3894636+00:00",
"suggested_user_id": "42933f1d-65ed-4673-b367-bec357187faf",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ff3acc5e-19d0-46a1-8adb-1725fbdfa60d",
"db_language_id": "7983d863-7351-47df-b6a7-5947a9f52c61",
"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-09-08T00:06:52.3894636+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "697eb949-cb40-40b0-8762-1fb4da6da6b7",
"sales_organization": {
"id": "8e51add0-b66f-4e9a-a97d-980ae6d9ae32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "510bbbfd-8b0e-4393-a86c-08b374ba898a",
"db_currency_id": "9cc77dca-4bfc-4100-b704-250275780bd0",
"db_language_id": "70b74c01-10de-4f4d-be3d-dc1b0300958f",
"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-09-08T00:06:52.3894636+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "97a02ee6-0e55-426e-a441-09f4395c85f9",
"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": "ba320683-9642-434b-bcdb-9426692cbaa1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-08T00:06:52.3894636+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2a39652d-df01-43cd-be25-c88ced58e0c2"
},
"suggested_date_start": "2026-09-08T00:06:52.3894636+00:00",
"skill_id": "aa70adcc-d416-43e8-99cc-85ddb0947959",
"skill_code": "sample string 32",
"skill": {
"id": "73cfed8f-25ef-4b7d-a076-8a1f2762ff4e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "91612fa5-1164-43a7-bf6c-f5664a3118ab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8e51add0-b66f-4e9a-a97d-980ae6d9ae32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "510bbbfd-8b0e-4393-a86c-08b374ba898a",
"db_currency_id": "9cc77dca-4bfc-4100-b704-250275780bd0",
"db_language_id": "70b74c01-10de-4f4d-be3d-dc1b0300958f",
"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-09-08T00:06:52.3894636+00:00"
},
"modified_dateutc": "2026-09-08T00:06:52.3894636+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "eabb8921-bc9c-4d09-b8c0-df23bac58c84",
"date_reported_by_company": "2026-09-08T00:06:52.3894636+00:00",
"id2": 36,
"company_id": "52ff277c-81a0-46a8-9747-5644d983c0c0",
"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": "e2cb294e-73f3-489f-8fc8-9c129f6791ec",
"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-09-08T00:06:52.3894636+00:00"
},
"work_instruction_details_id": "56e58f4a-c5e8-409f-a5e8-789ed6d1cdd3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8caf8881-0942-45ba-ba69-71747bdb5d92",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "778a8624-25f1-4e20-86d7-3da0b5783ba8",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-08T00:06:52.3894636+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": "045a0bf1-6c47-41e6-bb08-62600c00ce0b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-08T00:06:52.3894636+00:00"
}