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": "1240de47-4a24-4880-8a64-2d3df156c12e",
"jobs_id": "2907d9d6-6ec9-4974-bb4a-bf7af41b2c1a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "abb75903-4941-41ab-882d-32b3dd53f2ad",
"_parent_id": "6b442646-4599-4425-8d0d-46c34991bc7f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3f36e58b-746f-4dac-8f50-f278254dac1c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8c552a3f-b631-4b6f-80ef-54cee04a799c",
"_parent_id": "9a73a19f-f108-40a5-899b-095ed155438b",
"root_parent_id": "e9b80688-fbc4-469c-8c51-b5191afffb23",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0ef2fb6f-7045-4752-926b-a465a3a8b2a3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "003700b7-014a-43a6-9bbe-a6e35541ad2e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0ac45026-2ad0-4370-b823-5e55a1032a9a",
"_parent_code": "sample string 6",
"sales_organization_id": "3d134642-c2ed-47c1-b70d-8fe9529c203b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0ff8b05b-678b-4f35-b5cc-cbff4b3de59a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "580a3166-bc8f-4fa2-996f-8a93d3036567",
"db_currency_id": "67ada4a1-dd75-45fb-a7da-25a0ed4a8114",
"db_language_id": "e8a712b9-0e9a-4ce8-b03c-c0ecbd4c1a5e",
"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-02-18T11:00:11.0606542+00:00"
},
"modified_dateutc": "2026-02-18T11:00:11.0606542+00:00"
},
"equipment_model_id": "e83f8246-49af-4aa4-b63e-1e7c1322760c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "39f81328-e793-4ee9-bb18-ac329d8f320b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "16797552-5790-4e97-b748-441bf4b534ec",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "96b16ca8-f92d-4821-989e-fbb02737db4e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "881c564a-e673-44ed-bbe1-e4fa9e4d259e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0ff8b05b-678b-4f35-b5cc-cbff4b3de59a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "580a3166-bc8f-4fa2-996f-8a93d3036567",
"db_currency_id": "67ada4a1-dd75-45fb-a7da-25a0ed4a8114",
"db_language_id": "e8a712b9-0e9a-4ce8-b03c-c0ecbd4c1a5e",
"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-02-18T11:00:11.0606542+00:00"
},
"modified_dateutc": "2026-02-18T11:00:11.0606542+00:00"
},
"equipment_family_id": "fedf1214-1dc9-41b3-9c06-c5cb209dd06c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "003700b7-014a-43a6-9bbe-a6e35541ad2e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0ac45026-2ad0-4370-b823-5e55a1032a9a",
"_parent_code": "sample string 6",
"sales_organization_id": "3d134642-c2ed-47c1-b70d-8fe9529c203b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0ff8b05b-678b-4f35-b5cc-cbff4b3de59a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "580a3166-bc8f-4fa2-996f-8a93d3036567",
"db_currency_id": "67ada4a1-dd75-45fb-a7da-25a0ed4a8114",
"db_language_id": "e8a712b9-0e9a-4ce8-b03c-c0ecbd4c1a5e",
"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-02-18T11:00:11.0606542+00:00"
},
"modified_dateutc": "2026-02-18T11:00:11.0606542+00:00"
},
"date_in_production_since": "2026-02-18T11:00:11.0606542+00:00",
"date_out_of_production_since": "2026-02-18T11:00:11.0606542+00:00",
"date_end_support": "2026-02-18T11:00:11.0606542+00:00",
"sales_organization_id": "8c6ab663-a928-4e1d-b862-c2c53ade37cf",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0ff8b05b-678b-4f35-b5cc-cbff4b3de59a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "580a3166-bc8f-4fa2-996f-8a93d3036567",
"db_currency_id": "67ada4a1-dd75-45fb-a7da-25a0ed4a8114",
"db_language_id": "e8a712b9-0e9a-4ce8-b03c-c0ecbd4c1a5e",
"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-02-18T11:00:11.0606542+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-02-18T11:00:11.0606542+00:00"
},
"project_status_id": "d63a4c57-8dee-40db-93c6-836af0c13a48",
"project_status_code": "sample string 10",
"project_status": {
"id": "3c46a2b4-b3f6-4698-adcf-a9455dca46c1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "466cadad-43ae-44b4-9ed0-3c8ec7b63c66",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0ff8b05b-678b-4f35-b5cc-cbff4b3de59a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "580a3166-bc8f-4fa2-996f-8a93d3036567",
"db_currency_id": "67ada4a1-dd75-45fb-a7da-25a0ed4a8114",
"db_language_id": "e8a712b9-0e9a-4ce8-b03c-c0ecbd4c1a5e",
"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-02-18T11:00:11.0606542+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-18T11:00:11.0606542+00:00"
},
"company_id": "ba13eb40-7288-4ac2-98f9-2e9d81d17bfc",
"company_code": "sample string 12",
"db_address_id": "17c253b4-6203-4469-a266-15f3478c0dff",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2aa65f3a-0963-497e-963f-b564f7802a7e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9a5d89ff-cc7d-4ef9-b140-83d80270d341",
"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-02-18T11:00:11.0606542+00:00",
"date_create": "2026-02-18T11:00:11.0606542+00:00",
"date_update": "2026-02-18T11:00:11.0606542+00:00",
"updated_by_user_id": "185024a1-e86f-4c63-80a8-43b3450adeb6",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-18T11:00:11.0606542+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-02-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-18T11:00:11.0606542+00:00",
"date_last_job": "2026-02-18T11:00:11.0606542+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-18T11:00:11.0606542+00:00",
"modified_dateutc": "2026-02-18T11:00:11.0606542+00:00",
"is_mobile_installation": true
},
"job_type_id": "b04754fc-9492-4008-892e-480aa867ecee",
"job_type_code": "sample string 7",
"job_type": {
"id": "aceef535-a498-43f1-b9dd-67f97223f9cf",
"name": "sample string 2",
"sales_organization_id": "38b22cb7-4e02-4848-809a-f9aab795784b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-18T11:00:11.0606542+00:00",
"code": "sample string 7"
},
"job_priority_id": "247f63f6-d9fa-4f8d-ac60-3a1ccaf0ee7b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4fad5e67-ae50-41ed-9d8b-275ae82e2f0f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c34f8eb2-1685-4ddb-9846-d1a0fb0795e1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0ff8b05b-678b-4f35-b5cc-cbff4b3de59a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "580a3166-bc8f-4fa2-996f-8a93d3036567",
"db_currency_id": "67ada4a1-dd75-45fb-a7da-25a0ed4a8114",
"db_language_id": "e8a712b9-0e9a-4ce8-b03c-c0ecbd4c1a5e",
"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-02-18T11:00:11.0606542+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-18T11:00:11.0606542+00:00"
},
"job_status_id": "71debfcf-4fad-43ed-9bbe-f044aa297657",
"job_status_code": "sample string 11",
"db_address_id": "6647fb12-09a1-4d18-a6f3-9ad2a472c966",
"contact_id": "ece496bd-ad84-4754-92e3-938589c9c1c1",
"requested_by_company_id": "48e293c6-58c3-4480-a49e-d4736c962c18",
"requested_by_contact_id": "896df8dc-d275-40fb-a2db-635948a68ee8",
"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-02-18T11:00:11.0606542+00:00",
"due_date": "2026-02-18T11:00:11.0606542+00:00",
"date_create": "2026-02-18T11:00:11.0606542+00:00",
"date_update": "2026-02-18T11:00:11.0606542+00:00",
"date_closed": "2026-02-18T11:00:11.0606542+00:00",
"suggested_user_id": "c0ad73a3-a222-4ef3-b9b5-aba2ea588b78",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "239f064a-a411-4062-9348-e62f9bc95038",
"db_language_id": "d515cc4c-197e-4eab-9960-0eee05fbd44e",
"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-02-18T11:00:11.0606542+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ee057aed-00a9-41a5-b3c2-952ffa1a93ce",
"sales_organization": {
"id": "0ff8b05b-678b-4f35-b5cc-cbff4b3de59a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "580a3166-bc8f-4fa2-996f-8a93d3036567",
"db_currency_id": "67ada4a1-dd75-45fb-a7da-25a0ed4a8114",
"db_language_id": "e8a712b9-0e9a-4ce8-b03c-c0ecbd4c1a5e",
"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-02-18T11:00:11.0606542+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "cf81e7e2-dd95-4e44-b5e1-bad582af1103",
"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": "c1f1e7ad-06e4-442b-bef3-781022643b0e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-18T11:00:11.0606542+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9a930e06-4dd6-425e-a547-f179109599a8"
},
"suggested_date_start": "2026-02-18T11:00:11.0606542+00:00",
"skill_id": "feb6b248-6f8d-4194-97f8-da6de8b3ca43",
"skill_code": "sample string 32",
"skill": {
"id": "abea502e-18d3-4ad7-9d1b-49c693005f22",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "887a340a-3a1f-467f-b750-e2b6aeb51242",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0ff8b05b-678b-4f35-b5cc-cbff4b3de59a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "580a3166-bc8f-4fa2-996f-8a93d3036567",
"db_currency_id": "67ada4a1-dd75-45fb-a7da-25a0ed4a8114",
"db_language_id": "e8a712b9-0e9a-4ce8-b03c-c0ecbd4c1a5e",
"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-02-18T11:00:11.0606542+00:00"
},
"modified_dateutc": "2026-02-18T11:00:11.0606542+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1a59b650-6c9a-45c3-83bb-9dc93910f4d4",
"date_reported_by_company": "2026-02-18T11:00:11.0606542+00:00",
"id2": 36,
"company_id": "d2adc709-5f44-4e66-8c9b-ba96211ef27f",
"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": "2af59001-122c-4039-b572-b0a91adb2f77",
"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-02-18T11:00:11.0606542+00:00"
},
"work_instruction_details_id": "d70f951f-8b2f-4adf-91e4-dc48d21978f1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "974aac5a-02ce-46bd-9a07-c694f2fb63ff",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "eec357db-738a-4481-8fef-6b1c11a55c09",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-18T11:00:11.0763039+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": "d280a3bc-1676-425d-91f1-9121e5b85322",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-18T11:00:11.0763039+00:00"
}