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": "378806e8-0ca8-4ae7-878a-9d33e3ea7ee3",
"jobs_id": "7b8358c4-ff91-4bfd-af86-f2bf48474ee3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0501166b-49de-464e-8503-987068900fb5",
"_parent_id": "fe7e825e-e7bd-4d3e-b44b-abd1606cd09e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a91885d5-fa07-448b-83de-9a875943e9dc",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4a245715-6763-4e3a-95c8-00fb2ce1944f",
"_parent_id": "a7b8b1f8-5e88-46cd-be4c-00e32373c39a",
"root_parent_id": "f90f2d62-8ec7-4c16-ad89-40378ff1341d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9c52b96d-5354-4437-95b6-8b5b35633869",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "64f0d6b8-cf46-4a30-87f7-249a7958b8bc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9336e25f-07b2-4435-b0f4-3aadc8929cd5",
"_parent_code": "sample string 6",
"sales_organization_id": "1e78572f-ea23-405c-8bb8-3f1d87a2a9a8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f693a56e-2ca2-47d2-965e-3f00a092e0a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c77ef30-c45e-4e11-9365-6bf55c332242",
"db_currency_id": "d58c5a08-9594-4c31-a014-2a7e09120f6f",
"db_language_id": "c726b0ac-2998-4782-88dd-76280d0ba42c",
"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-09-05T12:19:32.4815097+00:00"
},
"modified_dateutc": "2025-09-05T12:19:32.4815097+00:00"
},
"equipment_model_id": "e570d0be-2b87-4fcb-b72d-cbe1664d953e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8442f23c-45fb-45ec-b85b-c9107f538a6b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1cbd8787-bacd-47ed-8968-0c542d6b701a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7bbf8063-09b5-4472-83a9-57dac58906b1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "03bdc200-6849-4a5d-be0c-f5b70f1b7202",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f693a56e-2ca2-47d2-965e-3f00a092e0a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c77ef30-c45e-4e11-9365-6bf55c332242",
"db_currency_id": "d58c5a08-9594-4c31-a014-2a7e09120f6f",
"db_language_id": "c726b0ac-2998-4782-88dd-76280d0ba42c",
"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-09-05T12:19:32.4815097+00:00"
},
"modified_dateutc": "2025-09-05T12:19:32.4815097+00:00"
},
"equipment_family_id": "06fdf6dc-9bf9-459f-a8fe-93b86b189769",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "64f0d6b8-cf46-4a30-87f7-249a7958b8bc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9336e25f-07b2-4435-b0f4-3aadc8929cd5",
"_parent_code": "sample string 6",
"sales_organization_id": "1e78572f-ea23-405c-8bb8-3f1d87a2a9a8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f693a56e-2ca2-47d2-965e-3f00a092e0a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c77ef30-c45e-4e11-9365-6bf55c332242",
"db_currency_id": "d58c5a08-9594-4c31-a014-2a7e09120f6f",
"db_language_id": "c726b0ac-2998-4782-88dd-76280d0ba42c",
"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-09-05T12:19:32.4815097+00:00"
},
"modified_dateutc": "2025-09-05T12:19:32.4815097+00:00"
},
"date_in_production_since": "2025-09-05T12:19:32.4815097+00:00",
"date_out_of_production_since": "2025-09-05T12:19:32.4815097+00:00",
"date_end_support": "2025-09-05T12:19:32.4815097+00:00",
"sales_organization_id": "9e3593e2-216a-408e-8fdb-4ce5082b3fac",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f693a56e-2ca2-47d2-965e-3f00a092e0a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c77ef30-c45e-4e11-9365-6bf55c332242",
"db_currency_id": "d58c5a08-9594-4c31-a014-2a7e09120f6f",
"db_language_id": "c726b0ac-2998-4782-88dd-76280d0ba42c",
"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-09-05T12:19:32.4815097+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-09-05T12:19:32.4815097+00:00"
},
"project_status_id": "f2592f82-a48d-4e5d-a8bc-0ca77a8b0972",
"project_status_code": "sample string 10",
"project_status": {
"id": "d36b709b-bc75-42f6-9806-b3c8f110f274",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3706d018-3670-4055-9125-099453b8af47",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f693a56e-2ca2-47d2-965e-3f00a092e0a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c77ef30-c45e-4e11-9365-6bf55c332242",
"db_currency_id": "d58c5a08-9594-4c31-a014-2a7e09120f6f",
"db_language_id": "c726b0ac-2998-4782-88dd-76280d0ba42c",
"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-09-05T12:19:32.4815097+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-05T12:19:32.4815097+00:00"
},
"company_id": "338dca63-42b6-4a3f-9519-38dbbbc7806d",
"company_code": "sample string 12",
"db_address_id": "c55ce7a5-bbf2-49a5-bbe8-15916f623b24",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c7cbf473-97f8-408f-ad20-04bd68654c37",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0daf1e35-58df-472f-8307-6cf41d5c5b95",
"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-09-05T12:19:32.4971377+00:00",
"date_create": "2025-09-05T12:19:32.4971377+00:00",
"date_update": "2025-09-05T12:19:32.4971377+00:00",
"updated_by_user_id": "28ab61c2-0dcd-44a0-bb26-75cde13a58d6",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-09-05T12:19:32.4971377+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-09-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-09-05T12:19:32.4971377+00:00",
"date_last_job": "2025-09-05T12:19:32.4971377+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-09-05T12:19:32.4971377+00:00",
"modified_dateutc": "2025-09-05T12:19:32.4971377+00:00",
"is_mobile_installation": true
},
"job_type_id": "501ad177-799d-45f1-8bbd-0a42642e6570",
"job_type_code": "sample string 7",
"job_type": {
"id": "102b68c4-b26e-4e3f-aa4b-63a916d0e252",
"name": "sample string 2",
"sales_organization_id": "f8a24107-25ac-43f3-a1a4-fa29575c638a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-09-05T12:19:32.4971377+00:00",
"code": "sample string 7"
},
"job_priority_id": "e16b60a6-b500-401c-bfb7-3398154fba7e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "30ecb6c0-6111-434c-9e2a-28c1f5784f59",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3e35d1ce-4afe-4a60-bd93-c119f617df31",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f693a56e-2ca2-47d2-965e-3f00a092e0a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c77ef30-c45e-4e11-9365-6bf55c332242",
"db_currency_id": "d58c5a08-9594-4c31-a014-2a7e09120f6f",
"db_language_id": "c726b0ac-2998-4782-88dd-76280d0ba42c",
"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-09-05T12:19:32.4815097+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-09-05T12:19:32.4971377+00:00"
},
"job_status_id": "03e239da-c165-455b-833c-f1cc07d5e82a",
"job_status_code": "sample string 11",
"db_address_id": "a402f08d-0eea-4b6c-a8f4-228f56b26a8f",
"contact_id": "039e1ea5-1fcc-4eed-a685-7af9cf8b4631",
"requested_by_company_id": "6772a427-9fed-4bca-a0ec-fc07e6cd0dd6",
"requested_by_contact_id": "e0202670-9967-438b-b2c3-60faa71a7fed",
"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-09-05T12:19:32.4971377+00:00",
"due_date": "2025-09-05T12:19:32.4971377+00:00",
"date_create": "2025-09-05T12:19:32.4971377+00:00",
"date_update": "2025-09-05T12:19:32.4971377+00:00",
"date_closed": "2025-09-05T12:19:32.4971377+00:00",
"suggested_user_id": "90ee24d5-fb60-4033-b2ed-6f2a48104090",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f8519396-066b-44f4-b0f0-cba7a0184e0f",
"db_language_id": "68e5d28a-0fbb-48ac-8cdb-1e01f3649a07",
"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-09-05T12:19:32.4971377+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3d782993-460c-473b-a8dd-93b58b1fe252",
"sales_organization": {
"id": "f693a56e-2ca2-47d2-965e-3f00a092e0a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c77ef30-c45e-4e11-9365-6bf55c332242",
"db_currency_id": "d58c5a08-9594-4c31-a014-2a7e09120f6f",
"db_language_id": "c726b0ac-2998-4782-88dd-76280d0ba42c",
"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-09-05T12:19:32.4815097+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e894ca5b-531a-4151-ad9d-bcbf7e81b46b",
"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": "0d439ce1-c98d-4367-b17c-743f30998e99",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-09-05T12:19:32.4971377+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "62e43edf-e1bf-4cf5-bf53-eb8f54e401c4"
},
"suggested_date_start": "2025-09-05T12:19:32.4971377+00:00",
"skill_id": "ae0f503e-5d5b-4d2d-8530-91a9e00df650",
"skill_code": "sample string 32",
"skill": {
"id": "b5f44f74-6b5d-4188-82a3-19cfeea244bc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b91256fb-7651-4f18-b581-84de227921cd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f693a56e-2ca2-47d2-965e-3f00a092e0a6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7c77ef30-c45e-4e11-9365-6bf55c332242",
"db_currency_id": "d58c5a08-9594-4c31-a014-2a7e09120f6f",
"db_language_id": "c726b0ac-2998-4782-88dd-76280d0ba42c",
"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-09-05T12:19:32.4815097+00:00"
},
"modified_dateutc": "2025-09-05T12:19:32.4971377+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4cebdc51-4002-4989-9015-5f305c18d1bc",
"date_reported_by_company": "2025-09-05T12:19:32.4971377+00:00",
"id2": 36,
"company_id": "cedcd62c-22f5-4c40-8bc5-5cbdb75246ec",
"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": "6762c8e1-1738-4cea-8490-a13160964326",
"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-09-05T12:19:32.4971377+00:00"
},
"work_instruction_details_id": "8b02ee06-9478-4dbc-bce1-9ba569d630c0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fa06707c-3db0-41f9-a318-6c4182c56b35",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "deda16b2-327e-4569-be7f-beb27a803fc1",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-09-05T12:19:32.4971377+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": "5c87fe9e-58be-4bb0-9a37-d81acbcad2ef",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-09-05T12:19:32.4971377+00:00"
}