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": "67501709-c9e6-4485-9339-c09c57dd0234",
"jobs_id": "bac431b9-12a8-4fd4-b5ea-c973d4265c10",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0deb6d52-e4c4-4b00-92ea-680b314de2fa",
"_parent_id": "968dc784-1021-4b62-b1be-bd429d4d4400",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a5518571-ba01-48c5-840d-5b5d2eb75e87",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f66833d0-db03-4e6a-8b94-ea15b63c38f6",
"_parent_id": "674c3369-3747-492f-90da-a5437fdfc198",
"root_parent_id": "99fe4403-4f26-4303-937a-30c6c1fdc4f9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0797f941-a15c-4386-8a22-e7dd5acd49a5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "dd92b853-1d3e-4047-a6aa-6b5cfc9d9713",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3162a23c-049b-4e4f-82cf-2ed1b9a62188",
"_parent_code": "sample string 6",
"sales_organization_id": "f50f0ad9-2a49-4d82-893c-cc55d2ccabcc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4f2758de-bfe9-4e1b-b3ce-c1ee62d3440c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e918707c-aeb0-4046-813f-1ebee090a9b8",
"db_currency_id": "06d83a48-ed05-432f-8cb5-dfdbaf4b2f57",
"db_language_id": "40096b62-4741-4762-87cb-21faf50fdcd3",
"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-06-02T03:49:44.8885588+00:00"
},
"modified_dateutc": "2026-06-02T03:49:44.8885588+00:00"
},
"equipment_model_id": "6344309a-d6b5-4853-a4ce-91b667c07229",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4ac0b488-13d1-4874-a9e2-961346edd332",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "623c78fc-87ac-4986-989b-d60860d14bf1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "aa7d4dde-76af-4d96-843b-df2e9cef431d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f95dfeb5-3930-4f44-955b-0579613eff3a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4f2758de-bfe9-4e1b-b3ce-c1ee62d3440c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e918707c-aeb0-4046-813f-1ebee090a9b8",
"db_currency_id": "06d83a48-ed05-432f-8cb5-dfdbaf4b2f57",
"db_language_id": "40096b62-4741-4762-87cb-21faf50fdcd3",
"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-06-02T03:49:44.8885588+00:00"
},
"modified_dateutc": "2026-06-02T03:49:44.8885588+00:00"
},
"equipment_family_id": "c48b6b3c-7d64-412f-8e0c-3bfb6512a54d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "dd92b853-1d3e-4047-a6aa-6b5cfc9d9713",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3162a23c-049b-4e4f-82cf-2ed1b9a62188",
"_parent_code": "sample string 6",
"sales_organization_id": "f50f0ad9-2a49-4d82-893c-cc55d2ccabcc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4f2758de-bfe9-4e1b-b3ce-c1ee62d3440c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e918707c-aeb0-4046-813f-1ebee090a9b8",
"db_currency_id": "06d83a48-ed05-432f-8cb5-dfdbaf4b2f57",
"db_language_id": "40096b62-4741-4762-87cb-21faf50fdcd3",
"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-06-02T03:49:44.8885588+00:00"
},
"modified_dateutc": "2026-06-02T03:49:44.8885588+00:00"
},
"date_in_production_since": "2026-06-02T03:49:44.8885588+00:00",
"date_out_of_production_since": "2026-06-02T03:49:44.8885588+00:00",
"date_end_support": "2026-06-02T03:49:44.8885588+00:00",
"sales_organization_id": "e98dc9d7-0626-4a51-8af7-17aeee844445",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4f2758de-bfe9-4e1b-b3ce-c1ee62d3440c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e918707c-aeb0-4046-813f-1ebee090a9b8",
"db_currency_id": "06d83a48-ed05-432f-8cb5-dfdbaf4b2f57",
"db_language_id": "40096b62-4741-4762-87cb-21faf50fdcd3",
"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-06-02T03:49:44.8885588+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-06-02T03:49:44.8885588+00:00"
},
"project_status_id": "ac285cf0-50ad-44b3-8f5b-a0ed1539f5b5",
"project_status_code": "sample string 10",
"project_status": {
"id": "742f09a1-c880-42c4-b44f-1e47e191f4c0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "be053e15-ff12-45d0-a81e-b29c7b5d3708",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4f2758de-bfe9-4e1b-b3ce-c1ee62d3440c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e918707c-aeb0-4046-813f-1ebee090a9b8",
"db_currency_id": "06d83a48-ed05-432f-8cb5-dfdbaf4b2f57",
"db_language_id": "40096b62-4741-4762-87cb-21faf50fdcd3",
"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-06-02T03:49:44.8885588+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-02T03:49:44.8885588+00:00"
},
"company_id": "6d6a64f2-8775-450e-a060-d7235a51db11",
"company_code": "sample string 12",
"db_address_id": "b73274e0-4d8c-4bcb-bfed-6e34d5efb31e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7cc4501e-cc6b-4509-9091-25399ebf74b6",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e3156a54-6465-41b5-8dcf-9281df1317bf",
"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-06-02T03:49:44.8885588+00:00",
"date_create": "2026-06-02T03:49:44.8885588+00:00",
"date_update": "2026-06-02T03:49:44.8885588+00:00",
"updated_by_user_id": "d16721a8-92ca-45dc-bc8e-5a9b293e9fc0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-02T03:49:44.8885588+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-06-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-02T03:49:44.8885588+00:00",
"date_last_job": "2026-06-02T03:49:44.8885588+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-02T03:49:44.8885588+00:00",
"modified_dateutc": "2026-06-02T03:49:44.8885588+00:00",
"is_mobile_installation": true
},
"job_type_id": "3725b12d-857a-4c8d-8fa0-5e84ed05050b",
"job_type_code": "sample string 7",
"job_type": {
"id": "9ee89d99-d904-4f5e-b981-7d760f179ce1",
"name": "sample string 2",
"sales_organization_id": "f09609d7-9896-446c-aa91-1f12bd236d0d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-02T03:49:44.8885588+00:00",
"code": "sample string 7"
},
"job_priority_id": "385a7a3b-c43e-4ba3-9524-0b69e5d61021",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3e75d380-2601-45d9-82de-417c81d3a3d8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "749dec7a-9c53-436d-b486-37eaa8956a7b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4f2758de-bfe9-4e1b-b3ce-c1ee62d3440c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e918707c-aeb0-4046-813f-1ebee090a9b8",
"db_currency_id": "06d83a48-ed05-432f-8cb5-dfdbaf4b2f57",
"db_language_id": "40096b62-4741-4762-87cb-21faf50fdcd3",
"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-06-02T03:49:44.8885588+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-02T03:49:44.8885588+00:00"
},
"job_status_id": "1c6b4cda-c95e-4ab3-86a4-bad2885c71fe",
"job_status_code": "sample string 11",
"db_address_id": "4049249a-d78a-4f26-9159-43e6ea7469e8",
"contact_id": "cff5880c-6925-4adf-a21a-111e572c19af",
"requested_by_company_id": "cbae860a-0dcc-47fb-b741-af18ceecfcb5",
"requested_by_contact_id": "549e6535-9668-40ea-8588-1982f859a72c",
"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-06-02T03:49:44.8885588+00:00",
"due_date": "2026-06-02T03:49:44.8885588+00:00",
"date_create": "2026-06-02T03:49:44.8885588+00:00",
"date_update": "2026-06-02T03:49:44.8885588+00:00",
"date_closed": "2026-06-02T03:49:44.8885588+00:00",
"suggested_user_id": "d1f58f84-fcc5-4b75-a81b-7adf2c5ffeac",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "83eb8dec-7a48-4e7f-ac9a-b7055e1dab0f",
"db_language_id": "a2de62c2-059e-4a07-ad6d-128ead1e9319",
"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-06-02T03:49:44.8885588+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "93ef1c1a-c561-4553-b061-7d5a2f7d5927",
"sales_organization": {
"id": "4f2758de-bfe9-4e1b-b3ce-c1ee62d3440c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e918707c-aeb0-4046-813f-1ebee090a9b8",
"db_currency_id": "06d83a48-ed05-432f-8cb5-dfdbaf4b2f57",
"db_language_id": "40096b62-4741-4762-87cb-21faf50fdcd3",
"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-06-02T03:49:44.8885588+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "63ffd071-0049-46e1-9226-daa742a9bc2c",
"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": "382323be-6d88-4f74-83c8-fd301e49f17d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-02T03:49:44.8885588+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "09cabef5-6bc7-45d1-b204-d47bb573ca8d"
},
"suggested_date_start": "2026-06-02T03:49:44.8885588+00:00",
"skill_id": "48a06c6b-b513-4e06-99ca-a4ff52b3c073",
"skill_code": "sample string 32",
"skill": {
"id": "b800b199-86d6-4a5e-a6f3-8c5144167501",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "2f29247a-bd16-44e3-be31-66b945530758",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4f2758de-bfe9-4e1b-b3ce-c1ee62d3440c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e918707c-aeb0-4046-813f-1ebee090a9b8",
"db_currency_id": "06d83a48-ed05-432f-8cb5-dfdbaf4b2f57",
"db_language_id": "40096b62-4741-4762-87cb-21faf50fdcd3",
"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-06-02T03:49:44.8885588+00:00"
},
"modified_dateutc": "2026-06-02T03:49:44.8885588+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8d828f8d-daca-4ded-9421-b3bec3ec0833",
"date_reported_by_company": "2026-06-02T03:49:44.8885588+00:00",
"id2": 36,
"company_id": "7b3f2b84-2612-486e-bf97-93249eed20b1",
"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": "b13d7219-3139-4e6e-af86-706d3bea15f5",
"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-06-02T03:49:44.8885588+00:00"
},
"work_instruction_details_id": "3820439d-1588-402f-b4ae-3de345bcc394",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f8bbc24e-c80c-4385-a125-955c5c676525",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1000d64d-bc1c-4843-9383-72504699a735",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-02T03:49:44.8885588+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": "f46b8112-71a0-4507-9e0d-ab06ee4abb6a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-02T03:49:44.8885588+00:00"
}