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": "e3f90659-a377-4c8a-9ce1-7f2279c19676",
"jobs_id": "9cb81d03-06ce-4bdf-9b50-cd2329cb4bbe",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f8468810-72e2-402d-887b-77468880c304",
"_parent_id": "8372de1a-51a6-4b84-8534-1a4544a36ac2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "dbfc50a5-1a12-4ccc-8633-7bf18590f533",
"project_reference_back_office": "sample string 5",
"project": {
"id": "71c877e2-e28f-49ea-ae47-94f4eb58026a",
"_parent_id": "b140ecc3-6771-4509-b562-b69075129e34",
"root_parent_id": "c461ab44-b425-4d3f-b84a-97cf20e790b0",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a2fe5647-152d-4c16-a9aa-9c1b8e75f1a3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "41e6f9ab-6d0c-405e-a213-d11af67eab16",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d2243a6a-ed21-4200-9583-613d513a212a",
"_parent_code": "sample string 6",
"sales_organization_id": "1aab2bfc-c8a8-40af-aed2-0e4bc257ba73",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4ee2f04e-b522-4f46-b2bc-6008d3098f7b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f23a8706-7bf8-4abd-9479-d2ef9fe81de9",
"db_currency_id": "c59290d4-23fc-4afd-b5b0-efd5564ef6b8",
"db_language_id": "ec82657e-f93a-4954-b0ab-02f5013b0c99",
"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-05-30T15:04:08.7687224+00:00"
},
"modified_dateutc": "2026-05-30T15:04:08.7687224+00:00"
},
"equipment_model_id": "24237f90-2ee9-4915-9663-5023add8e16f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a536a430-ae55-4bb8-b1d1-e9e82ad919d7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "42d1fdb8-a490-4ed3-bef3-7964d9d386b4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9a1ff322-d157-443e-aeee-ddf78ae12104",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "effca69e-af35-4dad-b8d3-9c757b743a2b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4ee2f04e-b522-4f46-b2bc-6008d3098f7b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f23a8706-7bf8-4abd-9479-d2ef9fe81de9",
"db_currency_id": "c59290d4-23fc-4afd-b5b0-efd5564ef6b8",
"db_language_id": "ec82657e-f93a-4954-b0ab-02f5013b0c99",
"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-05-30T15:04:08.7687224+00:00"
},
"modified_dateutc": "2026-05-30T15:04:08.7687224+00:00"
},
"equipment_family_id": "f37933ff-e59b-4268-b9e7-93c03285b9f4",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "41e6f9ab-6d0c-405e-a213-d11af67eab16",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d2243a6a-ed21-4200-9583-613d513a212a",
"_parent_code": "sample string 6",
"sales_organization_id": "1aab2bfc-c8a8-40af-aed2-0e4bc257ba73",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4ee2f04e-b522-4f46-b2bc-6008d3098f7b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f23a8706-7bf8-4abd-9479-d2ef9fe81de9",
"db_currency_id": "c59290d4-23fc-4afd-b5b0-efd5564ef6b8",
"db_language_id": "ec82657e-f93a-4954-b0ab-02f5013b0c99",
"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-05-30T15:04:08.7687224+00:00"
},
"modified_dateutc": "2026-05-30T15:04:08.7687224+00:00"
},
"date_in_production_since": "2026-05-30T15:04:08.7687224+00:00",
"date_out_of_production_since": "2026-05-30T15:04:08.7687224+00:00",
"date_end_support": "2026-05-30T15:04:08.7687224+00:00",
"sales_organization_id": "aa6b897d-23b3-4b1b-a93b-c7d77eb6353d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4ee2f04e-b522-4f46-b2bc-6008d3098f7b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f23a8706-7bf8-4abd-9479-d2ef9fe81de9",
"db_currency_id": "c59290d4-23fc-4afd-b5b0-efd5564ef6b8",
"db_language_id": "ec82657e-f93a-4954-b0ab-02f5013b0c99",
"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-05-30T15:04:08.7687224+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-05-30T15:04:08.7687224+00:00"
},
"project_status_id": "f39f198c-ce45-4e81-89cb-55d2b1e4b679",
"project_status_code": "sample string 10",
"project_status": {
"id": "600ab681-009f-40b9-8da2-09424ad232ec",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "561396da-c726-48ba-b1f0-eedc111befb0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4ee2f04e-b522-4f46-b2bc-6008d3098f7b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f23a8706-7bf8-4abd-9479-d2ef9fe81de9",
"db_currency_id": "c59290d4-23fc-4afd-b5b0-efd5564ef6b8",
"db_language_id": "ec82657e-f93a-4954-b0ab-02f5013b0c99",
"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-05-30T15:04:08.7687224+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-30T15:04:08.7687224+00:00"
},
"company_id": "c9e66068-5a54-48a5-b22d-111ef63b6e4b",
"company_code": "sample string 12",
"db_address_id": "99573886-9e23-43e6-b0b7-6ea7697d3548",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "07b34555-aafa-422a-a95f-792dea6e40e6",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "92ee3c8b-0890-4775-8b4a-533ee2949895",
"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-05-30T15:04:08.7687224+00:00",
"date_create": "2026-05-30T15:04:08.7687224+00:00",
"date_update": "2026-05-30T15:04:08.7687224+00:00",
"updated_by_user_id": "1453d42d-85ed-4469-87f4-0489f45f158b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-30T15:04:08.7687224+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-05-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-30T15:04:08.7687224+00:00",
"date_last_job": "2026-05-30T15:04:08.7687224+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-30T15:04:08.7687224+00:00",
"modified_dateutc": "2026-05-30T15:04:08.7687224+00:00",
"is_mobile_installation": true
},
"job_type_id": "6a2ff5d9-4705-4a17-a8bf-77739a07d27f",
"job_type_code": "sample string 7",
"job_type": {
"id": "268a8f70-2e98-4d60-9419-a91ceeb1742f",
"name": "sample string 2",
"sales_organization_id": "0812753d-f6bb-480d-b262-96b9e4344245",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-30T15:04:08.7687224+00:00",
"code": "sample string 7"
},
"job_priority_id": "a34ba114-6ca3-487c-b488-c53ccea1be3a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2b89b573-606b-4503-b4be-bf903f056d72",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "93501c15-1685-4fb7-967d-c4dd64b58d7c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4ee2f04e-b522-4f46-b2bc-6008d3098f7b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f23a8706-7bf8-4abd-9479-d2ef9fe81de9",
"db_currency_id": "c59290d4-23fc-4afd-b5b0-efd5564ef6b8",
"db_language_id": "ec82657e-f93a-4954-b0ab-02f5013b0c99",
"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-05-30T15:04:08.7687224+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-30T15:04:08.7687224+00:00"
},
"job_status_id": "4896c516-0401-4580-8abe-4c8cdf807da2",
"job_status_code": "sample string 11",
"db_address_id": "648cf163-7875-4857-8e9d-b355f85a6f68",
"contact_id": "34a2b6dd-2c77-45ed-acfd-23959c08e0ee",
"requested_by_company_id": "1cb9c234-4d80-4a4c-9a7e-bf3c256bd60f",
"requested_by_contact_id": "4109227e-20c5-43f2-8e74-e1c6d9d6d60b",
"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-05-30T15:04:08.7687224+00:00",
"due_date": "2026-05-30T15:04:08.7687224+00:00",
"date_create": "2026-05-30T15:04:08.7687224+00:00",
"date_update": "2026-05-30T15:04:08.7687224+00:00",
"date_closed": "2026-05-30T15:04:08.7687224+00:00",
"suggested_user_id": "0af420ed-b1db-4cbb-96a5-3b44d059fb43",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cb5681a5-f731-46e3-bc3b-8124a300eeec",
"db_language_id": "71803f2c-df1e-4978-9496-84b496e77638",
"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-05-30T15:04:08.7687224+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6f77f8c4-a402-4ffa-a849-addc7f09ddd2",
"sales_organization": {
"id": "4ee2f04e-b522-4f46-b2bc-6008d3098f7b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f23a8706-7bf8-4abd-9479-d2ef9fe81de9",
"db_currency_id": "c59290d4-23fc-4afd-b5b0-efd5564ef6b8",
"db_language_id": "ec82657e-f93a-4954-b0ab-02f5013b0c99",
"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-05-30T15:04:08.7687224+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "70b1e180-4fa2-4207-b184-629f2b6e992b",
"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": "f16860a1-bdb6-46b9-8c66-c0e7b276ea9d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-30T15:04:08.7687224+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f7b90bdc-4b28-47aa-bba5-c77935a68379"
},
"suggested_date_start": "2026-05-30T15:04:08.7687224+00:00",
"skill_id": "17a09a9c-fdc8-475d-977b-8849d2848522",
"skill_code": "sample string 32",
"skill": {
"id": "726a142e-1a15-4746-a960-743c95c8ab2a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e48f897c-6daa-4a96-92a9-911d80ebd2dd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4ee2f04e-b522-4f46-b2bc-6008d3098f7b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f23a8706-7bf8-4abd-9479-d2ef9fe81de9",
"db_currency_id": "c59290d4-23fc-4afd-b5b0-efd5564ef6b8",
"db_language_id": "ec82657e-f93a-4954-b0ab-02f5013b0c99",
"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-05-30T15:04:08.7687224+00:00"
},
"modified_dateutc": "2026-05-30T15:04:08.7687224+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "00e56646-bc61-4111-b282-d36fb10f1c5c",
"date_reported_by_company": "2026-05-30T15:04:08.7687224+00:00",
"id2": 36,
"company_id": "3e861d87-1a08-461b-820b-ac8cbeb7cd92",
"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": "c9f81cc8-05ec-4560-aa8d-17d5dd0b7395",
"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-05-30T15:04:08.7687224+00:00"
},
"work_instruction_details_id": "1daf9d7d-81d7-4b23-88a4-d23275ee7e17",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "25b75044-dc33-4c86-9de8-153da4cc175a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "343982a6-f758-4edf-bde0-035675d6f097",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-30T15:04:08.7687224+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": "e1c45340-b384-442b-922b-5f81cd75c677",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-30T15:04:08.7687224+00:00"
}