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": "568f9063-a365-4b6c-b15f-038c46677293",
"jobs_id": "dfef0aec-2009-4e41-99b6-be9d2dcd6918",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2ad8dbf2-3604-482b-852e-d1b20b3f8349",
"_parent_id": "0d3abdb9-20ca-4310-aa61-7b06e09903fd",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a0ec0e35-7a9e-4c92-a84d-f01aa5aa8ecf",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3f4d4147-7fb5-4419-af81-1d4020ab7754",
"_parent_id": "b6054b38-8c6d-4653-8bca-e1a226de5ec6",
"root_parent_id": "626eb312-bb88-4824-9817-36a17122fd55",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7e119d6e-1ec2-4dd0-91b2-47a9e91fdde4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "74b7245b-40df-4aee-84f6-1cd4ab9e46d6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2c901892-83c7-4901-92d3-10abe6d3d95d",
"_parent_code": "sample string 6",
"sales_organization_id": "c75a87d4-4b41-408a-9762-8660477a938c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5550c8e5-6c41-4ff1-9ef1-9c96e2610663",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9623ea18-9869-4e12-91f5-576f6fcf112e",
"db_currency_id": "06c507b6-43ba-43c6-81ce-b76fc07458c1",
"db_language_id": "251d1d7e-0592-4d25-8003-c75836fa166f",
"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-01-29T13:07:13.5701494+00:00"
},
"modified_dateutc": "2026-01-29T13:07:13.5701494+00:00"
},
"equipment_model_id": "fa50c231-dafd-4efe-913c-2c75347f85cf",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b64e24d5-c842-4f90-8657-d28a419b525f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c12bb086-75f3-4ad0-abf2-cc872f0e5dbf",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "216d5240-45ad-48cc-a398-02008c69f249",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "51aeb8be-a664-4cec-a034-0d99e2b9ff7a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5550c8e5-6c41-4ff1-9ef1-9c96e2610663",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9623ea18-9869-4e12-91f5-576f6fcf112e",
"db_currency_id": "06c507b6-43ba-43c6-81ce-b76fc07458c1",
"db_language_id": "251d1d7e-0592-4d25-8003-c75836fa166f",
"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-01-29T13:07:13.5701494+00:00"
},
"modified_dateutc": "2026-01-29T13:07:13.5701494+00:00"
},
"equipment_family_id": "94556e9e-92ed-400f-adc3-74bac0820a24",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "74b7245b-40df-4aee-84f6-1cd4ab9e46d6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2c901892-83c7-4901-92d3-10abe6d3d95d",
"_parent_code": "sample string 6",
"sales_organization_id": "c75a87d4-4b41-408a-9762-8660477a938c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5550c8e5-6c41-4ff1-9ef1-9c96e2610663",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9623ea18-9869-4e12-91f5-576f6fcf112e",
"db_currency_id": "06c507b6-43ba-43c6-81ce-b76fc07458c1",
"db_language_id": "251d1d7e-0592-4d25-8003-c75836fa166f",
"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-01-29T13:07:13.5701494+00:00"
},
"modified_dateutc": "2026-01-29T13:07:13.5701494+00:00"
},
"date_in_production_since": "2026-01-29T13:07:13.5701494+00:00",
"date_out_of_production_since": "2026-01-29T13:07:13.5701494+00:00",
"date_end_support": "2026-01-29T13:07:13.5701494+00:00",
"sales_organization_id": "c3fc73c5-1a01-49fe-b4bc-4d47ac8cd388",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5550c8e5-6c41-4ff1-9ef1-9c96e2610663",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9623ea18-9869-4e12-91f5-576f6fcf112e",
"db_currency_id": "06c507b6-43ba-43c6-81ce-b76fc07458c1",
"db_language_id": "251d1d7e-0592-4d25-8003-c75836fa166f",
"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-01-29T13:07:13.5701494+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-01-29T13:07:13.5701494+00:00"
},
"project_status_id": "587df110-0eae-4daf-93d8-616be5ac29d3",
"project_status_code": "sample string 10",
"project_status": {
"id": "119c9848-166b-4948-992c-70babfd3c959",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "eeccab17-d696-4465-a7a4-e528b566fa55",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5550c8e5-6c41-4ff1-9ef1-9c96e2610663",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9623ea18-9869-4e12-91f5-576f6fcf112e",
"db_currency_id": "06c507b6-43ba-43c6-81ce-b76fc07458c1",
"db_language_id": "251d1d7e-0592-4d25-8003-c75836fa166f",
"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-01-29T13:07:13.5701494+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-29T13:07:13.5701494+00:00"
},
"company_id": "b40961c1-6b59-4f46-b9db-e0e00260bf15",
"company_code": "sample string 12",
"db_address_id": "b4041f91-9034-415d-bd09-30251346b368",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1d62c693-d280-426e-8024-7fff0166646a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "09d4b237-9f63-437f-992a-2288dc3ea111",
"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-01-29T13:07:13.5701494+00:00",
"date_create": "2026-01-29T13:07:13.5701494+00:00",
"date_update": "2026-01-29T13:07:13.5701494+00:00",
"updated_by_user_id": "758564c9-d985-4046-b0aa-3e591ae69102",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-29T13:07:13.5701494+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-01-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-29T13:07:13.5701494+00:00",
"date_last_job": "2026-01-29T13:07:13.5701494+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-29T13:07:13.5701494+00:00",
"modified_dateutc": "2026-01-29T13:07:13.5701494+00:00",
"is_mobile_installation": true
},
"job_type_id": "53d2cbd7-f066-48de-9d8c-3b0785e493e1",
"job_type_code": "sample string 7",
"job_type": {
"id": "2f15a311-9baf-4be0-a184-ce8eaca06893",
"name": "sample string 2",
"sales_organization_id": "64a6a0ac-225b-4d37-8282-14866d51490c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-29T13:07:13.5701494+00:00",
"code": "sample string 7"
},
"job_priority_id": "2b609659-afea-48cb-a00b-0e9ce9f476d8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "154ea1e2-631a-450e-97df-5ffb55fe4ad7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c5f4d325-3121-4e8a-ab28-a82a24d9e66c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5550c8e5-6c41-4ff1-9ef1-9c96e2610663",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9623ea18-9869-4e12-91f5-576f6fcf112e",
"db_currency_id": "06c507b6-43ba-43c6-81ce-b76fc07458c1",
"db_language_id": "251d1d7e-0592-4d25-8003-c75836fa166f",
"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-01-29T13:07:13.5701494+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-29T13:07:13.5701494+00:00"
},
"job_status_id": "ea29deb9-7bdc-4330-a2a7-f81243e5cf42",
"job_status_code": "sample string 11",
"db_address_id": "1afc3813-f005-411d-abe4-435314bc2064",
"contact_id": "672e5f7c-331c-4724-82dc-a663fe665db7",
"requested_by_company_id": "4ce76670-b002-43e4-b16e-318a9c81e3d7",
"requested_by_contact_id": "28fee1c3-cd7f-4d14-b625-0f106f5c16f2",
"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-01-29T13:07:13.5701494+00:00",
"due_date": "2026-01-29T13:07:13.5701494+00:00",
"date_create": "2026-01-29T13:07:13.5701494+00:00",
"date_update": "2026-01-29T13:07:13.5701494+00:00",
"date_closed": "2026-01-29T13:07:13.5701494+00:00",
"suggested_user_id": "29d50fae-5eb5-48b1-ad07-e6a611d69f56",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7637d636-8407-43aa-b7d1-2517bd11cf1f",
"db_language_id": "59fd77cd-878c-4fc2-a06a-8b7fa3678f27",
"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-01-29T13:07:13.5701494+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "105a6eb2-eeee-4ddd-89d0-8941911afd1c",
"sales_organization": {
"id": "5550c8e5-6c41-4ff1-9ef1-9c96e2610663",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9623ea18-9869-4e12-91f5-576f6fcf112e",
"db_currency_id": "06c507b6-43ba-43c6-81ce-b76fc07458c1",
"db_language_id": "251d1d7e-0592-4d25-8003-c75836fa166f",
"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-01-29T13:07:13.5701494+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c5e75d42-b507-48b9-a736-003dd1547d23",
"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": "aba7d481-293d-464f-acd1-d7f4b0c09c47",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-29T13:07:13.5701494+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "606fe69c-97b7-4395-bb51-accc4dc57812"
},
"suggested_date_start": "2026-01-29T13:07:13.5701494+00:00",
"skill_id": "b5c919fa-6ca8-4641-807d-3614a80102cf",
"skill_code": "sample string 32",
"skill": {
"id": "49a8650a-0d9a-4b25-b9ce-800fd525bcaf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b237fc77-9f46-4d58-a39d-94ff813c423c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5550c8e5-6c41-4ff1-9ef1-9c96e2610663",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9623ea18-9869-4e12-91f5-576f6fcf112e",
"db_currency_id": "06c507b6-43ba-43c6-81ce-b76fc07458c1",
"db_language_id": "251d1d7e-0592-4d25-8003-c75836fa166f",
"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-01-29T13:07:13.5701494+00:00"
},
"modified_dateutc": "2026-01-29T13:07:13.5701494+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7b96597f-7f12-4c45-9721-f65cf8591e16",
"date_reported_by_company": "2026-01-29T13:07:13.5701494+00:00",
"id2": 36,
"company_id": "ef06cdca-82ac-48db-941a-c4f20f548e87",
"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": "a100e565-7b87-4840-9907-f62e698102f1",
"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-01-29T13:07:13.5857747+00:00"
},
"work_instruction_details_id": "1d25a109-a126-4bf7-a1f9-a358344a50fc",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "40516823-8795-42d3-88e3-52a39160e3db",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c0284a78-1ec6-459c-8bb0-198dc366abbb",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-29T13:07:13.5857747+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": "540591f2-5489-4525-a23a-5f003a409cc3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-29T13:07:13.5857747+00:00"
}