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": "3efe131d-c0f0-4288-a668-0519f49af071",
"jobs_id": "a178ea4c-87fc-4b83-ab43-b351b5c88c2f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4f9a4c5a-d837-4b1e-91cb-47aa822772d7",
"_parent_id": "efe8396a-2baf-41d7-97f2-15f76ec072d0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "400bfb88-4f7e-4ed3-a6b7-b3ec657421a9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "23e61e51-0cff-4374-8fce-f96f1d4619f8",
"_parent_id": "818a65d9-d454-4329-bace-299d34ed2574",
"root_parent_id": "3989cb7a-25bb-4993-a9c0-6ce3b2ee1f57",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ee1e5e0c-e836-4e64-a97e-d72585dc4d63",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e36cd5bd-b8d9-46b3-bda7-ee4195e1bcaf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4dc5bc74-ced8-442c-b5b2-b09fd9e80d27",
"_parent_code": "sample string 6",
"sales_organization_id": "bef109a1-0d13-43bb-91f5-59fb42bf5da5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7c4ff289-bc1c-4b07-ae74-22caee05bf2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6a75d47-acd3-44de-8996-0e5dec2229c9",
"db_currency_id": "b7e9958a-aee5-4984-8758-ae5d065f729b",
"db_language_id": "92e9201b-6c79-4df9-8da1-e6fe2d5f865a",
"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-19T10:09:39.32438+00:00"
},
"modified_dateutc": "2025-12-19T10:09:39.32438+00:00"
},
"equipment_model_id": "940f418e-376c-409f-a38e-32f0e206b751",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5c59954f-49af-46f7-85a1-2fbef76b146c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "98e6dc5a-9ad5-4921-8a4c-f2b293315fb8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "733aa75d-af34-4aee-954f-726339c365d6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0ac13e81-27fc-4a27-8cea-a7f621ddb727",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7c4ff289-bc1c-4b07-ae74-22caee05bf2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6a75d47-acd3-44de-8996-0e5dec2229c9",
"db_currency_id": "b7e9958a-aee5-4984-8758-ae5d065f729b",
"db_language_id": "92e9201b-6c79-4df9-8da1-e6fe2d5f865a",
"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-19T10:09:39.32438+00:00"
},
"modified_dateutc": "2025-12-19T10:09:39.32438+00:00"
},
"equipment_family_id": "18747bfb-ff07-40a0-9881-34dade42ba3a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e36cd5bd-b8d9-46b3-bda7-ee4195e1bcaf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4dc5bc74-ced8-442c-b5b2-b09fd9e80d27",
"_parent_code": "sample string 6",
"sales_organization_id": "bef109a1-0d13-43bb-91f5-59fb42bf5da5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7c4ff289-bc1c-4b07-ae74-22caee05bf2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6a75d47-acd3-44de-8996-0e5dec2229c9",
"db_currency_id": "b7e9958a-aee5-4984-8758-ae5d065f729b",
"db_language_id": "92e9201b-6c79-4df9-8da1-e6fe2d5f865a",
"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-19T10:09:39.32438+00:00"
},
"modified_dateutc": "2025-12-19T10:09:39.32438+00:00"
},
"date_in_production_since": "2025-12-19T10:09:39.32438+00:00",
"date_out_of_production_since": "2025-12-19T10:09:39.32438+00:00",
"date_end_support": "2025-12-19T10:09:39.32438+00:00",
"sales_organization_id": "b5fddac2-0887-43f8-bff7-bbb2c00f9f2c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7c4ff289-bc1c-4b07-ae74-22caee05bf2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6a75d47-acd3-44de-8996-0e5dec2229c9",
"db_currency_id": "b7e9958a-aee5-4984-8758-ae5d065f729b",
"db_language_id": "92e9201b-6c79-4df9-8da1-e6fe2d5f865a",
"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-19T10:09:39.32438+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-19T10:09:39.3400052+00:00"
},
"project_status_id": "834bbdaa-0315-4906-b8ff-aae52103277b",
"project_status_code": "sample string 10",
"project_status": {
"id": "7f0f3b0b-675b-4271-994d-d32e1b69b301",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d63d67ce-25b5-4621-b24d-ec665b37239d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7c4ff289-bc1c-4b07-ae74-22caee05bf2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6a75d47-acd3-44de-8996-0e5dec2229c9",
"db_currency_id": "b7e9958a-aee5-4984-8758-ae5d065f729b",
"db_language_id": "92e9201b-6c79-4df9-8da1-e6fe2d5f865a",
"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-19T10:09:39.32438+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-19T10:09:39.3400052+00:00"
},
"company_id": "4a81201c-ce18-47a7-95d7-6bf47a3cdf98",
"company_code": "sample string 12",
"db_address_id": "4170a4e9-6aa8-4497-bd4d-4afdb634ddab",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "933c538f-d9f4-43b8-b56f-54b1637240ca",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "410d2f33-3bbc-48ae-818d-3a16381c5e56",
"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-19T10:09:39.3400052+00:00",
"date_create": "2025-12-19T10:09:39.3400052+00:00",
"date_update": "2025-12-19T10:09:39.3400052+00:00",
"updated_by_user_id": "52528429-d1d6-4787-a6e5-9bdae582e199",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-19T10:09:39.3400052+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-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-19T10:09:39.3400052+00:00",
"date_last_job": "2025-12-19T10:09:39.3400052+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-19T10:09:39.3400052+00:00",
"modified_dateutc": "2025-12-19T10:09:39.3400052+00:00",
"is_mobile_installation": true
},
"job_type_id": "42b4b1e7-a4eb-4e43-a7fe-d29d46c22b05",
"job_type_code": "sample string 7",
"job_type": {
"id": "34108ac7-6ad2-46d6-9bbb-efddcd06a671",
"name": "sample string 2",
"sales_organization_id": "c4d4aac4-b4af-4d2b-a4e8-6b7c8b766bae",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-19T10:09:39.3400052+00:00",
"code": "sample string 7"
},
"job_priority_id": "6d863c0f-f48a-4c31-84f8-0beed969ee53",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3fdbf6a8-c4c6-4a1c-ba9b-6c891ada411d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "80dbc054-2299-410e-9e6e-53caceefc80d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7c4ff289-bc1c-4b07-ae74-22caee05bf2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6a75d47-acd3-44de-8996-0e5dec2229c9",
"db_currency_id": "b7e9958a-aee5-4984-8758-ae5d065f729b",
"db_language_id": "92e9201b-6c79-4df9-8da1-e6fe2d5f865a",
"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-19T10:09:39.32438+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-19T10:09:39.3400052+00:00"
},
"job_status_id": "7b74090b-ff82-487f-8cf2-114ca4afce05",
"job_status_code": "sample string 11",
"db_address_id": "02ab7bd3-f18c-48ee-863c-51bf8f37df8f",
"contact_id": "41964db4-4331-42aa-9afb-0a11e4ab4478",
"requested_by_company_id": "1e36e922-138a-44a6-afd9-5cd9edd9b9c1",
"requested_by_contact_id": "e88768c8-ade6-4e82-b6c8-c0dbad90750c",
"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-19T10:09:39.3400052+00:00",
"due_date": "2025-12-19T10:09:39.3400052+00:00",
"date_create": "2025-12-19T10:09:39.3400052+00:00",
"date_update": "2025-12-19T10:09:39.3400052+00:00",
"date_closed": "2025-12-19T10:09:39.3400052+00:00",
"suggested_user_id": "1c835ef7-9c22-4e30-836e-bfc12d0d1747",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1a092142-c16f-49d3-810d-df0ccf14ffbc",
"db_language_id": "c9c67ecd-b3a1-447f-a649-9b860b3c22ef",
"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-19T10:09:39.3400052+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "15198e1a-f255-4fac-9ccb-7b3cb98804bc",
"sales_organization": {
"id": "7c4ff289-bc1c-4b07-ae74-22caee05bf2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6a75d47-acd3-44de-8996-0e5dec2229c9",
"db_currency_id": "b7e9958a-aee5-4984-8758-ae5d065f729b",
"db_language_id": "92e9201b-6c79-4df9-8da1-e6fe2d5f865a",
"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-19T10:09:39.32438+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f744851a-41a5-4484-9aed-1c9cb5a94a6f",
"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": "1ff87e28-4ace-42d1-9e17-35863d52a109",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-19T10:09:39.3400052+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5707d549-688e-4290-bcd9-b32e03e6980d"
},
"suggested_date_start": "2025-12-19T10:09:39.3400052+00:00",
"skill_id": "db390a94-db80-4f06-9799-a4c1117ae7de",
"skill_code": "sample string 32",
"skill": {
"id": "bb56039c-a97b-4ae6-8417-a986919d7bb6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "60b690bb-0896-4f1f-b924-a90f39baabaa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7c4ff289-bc1c-4b07-ae74-22caee05bf2f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6a75d47-acd3-44de-8996-0e5dec2229c9",
"db_currency_id": "b7e9958a-aee5-4984-8758-ae5d065f729b",
"db_language_id": "92e9201b-6c79-4df9-8da1-e6fe2d5f865a",
"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-19T10:09:39.32438+00:00"
},
"modified_dateutc": "2025-12-19T10:09:39.3400052+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f89e8c95-f6e9-4323-8758-576e1cf54b05",
"date_reported_by_company": "2025-12-19T10:09:39.3400052+00:00",
"id2": 36,
"company_id": "f92db4dd-eecb-4f19-a300-a304610e61d7",
"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": "b4fcb784-8d48-4bda-8e4c-77c8169dc863",
"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-19T10:09:39.3400052+00:00"
},
"work_instruction_details_id": "2a7f4950-c34e-4b4a-b461-2e56fee86487",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ac266264-9d47-4a41-8196-61ff348e1b96",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "047f79fe-d723-424c-965e-23b438f3e98d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-19T10:09:39.3400052+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": "132a2d5a-8c09-4271-a9e4-dcac2a1779bc",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-19T10:09:39.3400052+00:00"
}