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": "14da85f1-8dd9-43be-8ce9-2ec29857bb4b",
"jobs_id": "3377c773-1d8c-4ab1-a62d-faafa5f17be2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "28b82c25-f79e-4fc2-9e28-3fcc555adb04",
"_parent_id": "dd2c6701-71dc-4511-ab78-14c72ae7bda4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "40051c25-ba1f-4bcb-bab6-dba2a7167faf",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ef1eded1-3ced-441f-a7fd-a984fd980632",
"_parent_id": "b662bc3b-0179-46ec-b161-086ae4eacef3",
"root_parent_id": "3df65173-55b4-4625-aa48-78c3bfc943f1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cfb60d39-a741-4d70-a336-eacde548ec3e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "89deb6c4-3406-49a3-9abe-280b2a6ed231",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1b32380d-9a72-4dfe-a0c9-3eeb51f3abc3",
"_parent_code": "sample string 6",
"sales_organization_id": "0e0e9ca3-6e34-426b-acff-4ab68c11cf69",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "14420505-6f1e-44fe-825b-603b2ac31a6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e24709b-bf40-4e9e-8272-4c01d74b83f8",
"db_currency_id": "d5b4adba-20c3-4e73-888b-f4cd092960b4",
"db_language_id": "c188465c-0abf-45b5-9bb1-de653dd47b33",
"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-10-15T08:29:23.7489736+00:00"
},
"modified_dateutc": "2026-10-15T08:29:23.7489736+00:00"
},
"equipment_model_id": "58cba4b4-8f96-4c71-ba0f-c0231d1dee46",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "245facdd-a22c-4731-989a-57d892364833",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "951f12a3-f618-4151-9df6-c70bec36be77",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0d6836c5-594b-419d-a936-40023bed437f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1916d873-e283-4de4-92eb-4d4bde13654a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "14420505-6f1e-44fe-825b-603b2ac31a6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e24709b-bf40-4e9e-8272-4c01d74b83f8",
"db_currency_id": "d5b4adba-20c3-4e73-888b-f4cd092960b4",
"db_language_id": "c188465c-0abf-45b5-9bb1-de653dd47b33",
"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-10-15T08:29:23.7489736+00:00"
},
"modified_dateutc": "2026-10-15T08:29:23.7489736+00:00"
},
"equipment_family_id": "933ff05c-5558-4901-a7d1-890a6a4f4584",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "89deb6c4-3406-49a3-9abe-280b2a6ed231",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "1b32380d-9a72-4dfe-a0c9-3eeb51f3abc3",
"_parent_code": "sample string 6",
"sales_organization_id": "0e0e9ca3-6e34-426b-acff-4ab68c11cf69",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "14420505-6f1e-44fe-825b-603b2ac31a6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e24709b-bf40-4e9e-8272-4c01d74b83f8",
"db_currency_id": "d5b4adba-20c3-4e73-888b-f4cd092960b4",
"db_language_id": "c188465c-0abf-45b5-9bb1-de653dd47b33",
"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-10-15T08:29:23.7489736+00:00"
},
"modified_dateutc": "2026-10-15T08:29:23.7489736+00:00"
},
"date_in_production_since": "2026-10-15T08:29:23.7489736+00:00",
"date_out_of_production_since": "2026-10-15T08:29:23.7489736+00:00",
"date_end_support": "2026-10-15T08:29:23.7489736+00:00",
"sales_organization_id": "1eddec99-7962-4604-86d4-2d61dc9ba951",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "14420505-6f1e-44fe-825b-603b2ac31a6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e24709b-bf40-4e9e-8272-4c01d74b83f8",
"db_currency_id": "d5b4adba-20c3-4e73-888b-f4cd092960b4",
"db_language_id": "c188465c-0abf-45b5-9bb1-de653dd47b33",
"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-10-15T08:29:23.7489736+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-10-15T08:29:23.7489736+00:00"
},
"project_status_id": "34e70e0f-9cf6-4f52-ae61-cd5609087f08",
"project_status_code": "sample string 10",
"project_status": {
"id": "307eae77-7cd6-4e58-b421-3506bb5e9a3c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9e3f35b9-04b4-4c09-ae69-a97076470682",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "14420505-6f1e-44fe-825b-603b2ac31a6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e24709b-bf40-4e9e-8272-4c01d74b83f8",
"db_currency_id": "d5b4adba-20c3-4e73-888b-f4cd092960b4",
"db_language_id": "c188465c-0abf-45b5-9bb1-de653dd47b33",
"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-10-15T08:29:23.7489736+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-15T08:29:23.7489736+00:00"
},
"company_id": "eaa7ce23-9a4d-4a9a-8601-ef9ad9470033",
"company_code": "sample string 12",
"db_address_id": "d4bd9c2f-86b9-4da6-892e-c08153f31aeb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "302b83d4-898d-4890-9423-02e9197784a1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "70f5ed46-ce5d-4603-a5c0-cca628646f7d",
"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-10-15T08:29:23.7489736+00:00",
"date_create": "2026-10-15T08:29:23.7489736+00:00",
"date_update": "2026-10-15T08:29:23.7489736+00:00",
"updated_by_user_id": "79023b62-73e9-4091-9c2d-37ed9d80fda4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-15T08:29:23.7489736+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-10-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-15T08:29:23.7489736+00:00",
"date_last_job": "2026-10-15T08:29:23.7489736+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-15T08:29:23.7489736+00:00",
"modified_dateutc": "2026-10-15T08:29:23.7489736+00:00",
"is_mobile_installation": true
},
"job_type_id": "a96c12af-9943-4f33-a3fb-c2f6d7403ae3",
"job_type_code": "sample string 7",
"job_type": {
"id": "b6480cf3-1343-4348-8f20-3263df6e0c41",
"name": "sample string 2",
"sales_organization_id": "9f4d341b-9251-4238-94b0-5858d4cecd7f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-15T08:29:23.7489736+00:00",
"code": "sample string 7"
},
"job_priority_id": "37be0c59-97b0-4807-9db4-5c7c3aacfc0b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2b5d4979-2e01-4998-ad77-8a2b5fb6b696",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3e6ff36b-b46b-4c44-bd9a-89f95903e144",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "14420505-6f1e-44fe-825b-603b2ac31a6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e24709b-bf40-4e9e-8272-4c01d74b83f8",
"db_currency_id": "d5b4adba-20c3-4e73-888b-f4cd092960b4",
"db_language_id": "c188465c-0abf-45b5-9bb1-de653dd47b33",
"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-10-15T08:29:23.7489736+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-15T08:29:23.7489736+00:00"
},
"job_status_id": "3788da3f-3b63-4d7f-a8fe-75e997677986",
"job_status_code": "sample string 11",
"db_address_id": "67101ba8-7eb1-4b9f-b8c6-5b8987b89e63",
"contact_id": "4cbcee8a-7d02-48d4-b459-52e6c25b7c59",
"requested_by_company_id": "c1b268a7-b119-41e3-9a1f-8e7d3b6697aa",
"requested_by_contact_id": "9494c9ad-c819-4d31-92e9-685e1d953591",
"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-10-15T08:29:23.7489736+00:00",
"due_date": "2026-10-15T08:29:23.7489736+00:00",
"date_create": "2026-10-15T08:29:23.7489736+00:00",
"date_update": "2026-10-15T08:29:23.7489736+00:00",
"date_closed": "2026-10-15T08:29:23.7489736+00:00",
"suggested_user_id": "bc61fd5a-8dca-4307-aae6-043c6c683dab",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1715d171-ed4f-440b-989f-1d12d83b4fe6",
"db_language_id": "c05e3c6c-ab7e-40ef-b398-5ffbfe38613f",
"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-10-15T08:29:23.7489736+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d35ba003-09d0-4160-a335-5de84d092309",
"sales_organization": {
"id": "14420505-6f1e-44fe-825b-603b2ac31a6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e24709b-bf40-4e9e-8272-4c01d74b83f8",
"db_currency_id": "d5b4adba-20c3-4e73-888b-f4cd092960b4",
"db_language_id": "c188465c-0abf-45b5-9bb1-de653dd47b33",
"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-10-15T08:29:23.7489736+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9f59f806-7a84-42b1-8012-1d7c22ff388d",
"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": "4f74bfe4-422a-48b7-964e-abde62fd983f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-15T08:29:23.7489736+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "dcc75373-6f60-4d72-9c55-bd04d3a26f97"
},
"suggested_date_start": "2026-10-15T08:29:23.7489736+00:00",
"skill_id": "b44701b0-d5bf-4c9a-ab99-ada2512efa83",
"skill_code": "sample string 32",
"skill": {
"id": "d75402f7-14bd-476c-ad7a-e7d55145b94b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "33eb4a86-a718-4074-ace6-02c174231fb1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "14420505-6f1e-44fe-825b-603b2ac31a6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5e24709b-bf40-4e9e-8272-4c01d74b83f8",
"db_currency_id": "d5b4adba-20c3-4e73-888b-f4cd092960b4",
"db_language_id": "c188465c-0abf-45b5-9bb1-de653dd47b33",
"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-10-15T08:29:23.7489736+00:00"
},
"modified_dateutc": "2026-10-15T08:29:23.7685151+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1f825034-3701-48a9-8276-bc9f2641302a",
"date_reported_by_company": "2026-10-15T08:29:23.7685151+00:00",
"id2": 36,
"company_id": "a4a7d93c-2894-4d06-9644-a89d9c809876",
"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": "809b9151-7aab-4031-a55b-472db2028e5a",
"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-10-15T08:29:23.7685151+00:00"
},
"work_instruction_details_id": "4e64a6ce-ad11-4e0b-9a98-9e6c4498800c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5b83c658-c78d-489f-81cc-4bbdbe5ad132",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c187bf1c-a069-48e6-bc3e-d989da3c2c2e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-15T08:29:23.7685151+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": "909a92ac-7268-4b6f-8f4a-b06864714b91",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-15T08:29:23.7685151+00:00"
}