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": "52a6831f-2de7-4d82-b018-6a9e6ab1b1d0",
"jobs_id": "73ef8207-1e6d-4750-90fb-3ff16c6f10b4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6a91a5e8-88ea-425b-b7ba-4e153ab9eb1d",
"_parent_id": "42b9e018-d3f9-44c1-813f-0507218ae601",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ba8c85b1-7e11-419f-bcbf-0758141ee47c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "48168455-d579-4543-a405-d9b43979a258",
"_parent_id": "cdc55aa1-fd65-4355-a2a0-ed0e422f513f",
"root_parent_id": "bdb863af-345c-495a-9d20-da82079332cc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "526ce277-4623-4480-b938-b7b33f024229",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7cd5e308-71a7-4a29-a246-1f33a3e85c34",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "195a4a3f-8587-4302-af2c-b2522f054d7f",
"_parent_code": "sample string 6",
"sales_organization_id": "a1e80f82-247e-4a7f-b101-86df1144d503",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "23d0c02e-26ce-49a3-bc8d-f8b02e9bf970",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ad607f2-a5c1-45dc-88e3-92b5e108ea82",
"db_currency_id": "2eb751cb-aa9f-4605-b8ae-2d6b91069f68",
"db_language_id": "3fc5f44a-f9b8-4a08-a72e-b494d0598772",
"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-17T07:42:54.0338065+00:00"
},
"modified_dateutc": "2026-06-17T07:42:54.0338065+00:00"
},
"equipment_model_id": "b98df608-e68e-4573-a44a-447c784f3848",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "21aba4e3-655c-4fae-852d-24fdcdf4db38",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a5e9051e-f524-4424-a828-7b233ae63b0c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f1f68db5-0ebc-4e96-9ab4-21a35b156f43",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "943d1a0d-9f62-4139-8b29-1d478bf43e16",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "23d0c02e-26ce-49a3-bc8d-f8b02e9bf970",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ad607f2-a5c1-45dc-88e3-92b5e108ea82",
"db_currency_id": "2eb751cb-aa9f-4605-b8ae-2d6b91069f68",
"db_language_id": "3fc5f44a-f9b8-4a08-a72e-b494d0598772",
"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-17T07:42:54.0338065+00:00"
},
"modified_dateutc": "2026-06-17T07:42:54.0338065+00:00"
},
"equipment_family_id": "247e7fe2-c546-4827-97bd-273ebc7b1460",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7cd5e308-71a7-4a29-a246-1f33a3e85c34",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "195a4a3f-8587-4302-af2c-b2522f054d7f",
"_parent_code": "sample string 6",
"sales_organization_id": "a1e80f82-247e-4a7f-b101-86df1144d503",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "23d0c02e-26ce-49a3-bc8d-f8b02e9bf970",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ad607f2-a5c1-45dc-88e3-92b5e108ea82",
"db_currency_id": "2eb751cb-aa9f-4605-b8ae-2d6b91069f68",
"db_language_id": "3fc5f44a-f9b8-4a08-a72e-b494d0598772",
"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-17T07:42:54.0338065+00:00"
},
"modified_dateutc": "2026-06-17T07:42:54.0338065+00:00"
},
"date_in_production_since": "2026-06-17T07:42:54.0338065+00:00",
"date_out_of_production_since": "2026-06-17T07:42:54.0338065+00:00",
"date_end_support": "2026-06-17T07:42:54.0338065+00:00",
"sales_organization_id": "af936bf7-0d6c-4fe4-b688-d96545d1266c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "23d0c02e-26ce-49a3-bc8d-f8b02e9bf970",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ad607f2-a5c1-45dc-88e3-92b5e108ea82",
"db_currency_id": "2eb751cb-aa9f-4605-b8ae-2d6b91069f68",
"db_language_id": "3fc5f44a-f9b8-4a08-a72e-b494d0598772",
"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-17T07:42:54.0338065+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-17T07:42:54.0338065+00:00"
},
"project_status_id": "cf69f43f-d24d-4f11-85d7-9161086cc682",
"project_status_code": "sample string 10",
"project_status": {
"id": "fae804dd-5ac6-4464-97f5-a3e39b6281e0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "d75dbc64-2af9-4ef1-87e8-f4cdb1a35c51",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "23d0c02e-26ce-49a3-bc8d-f8b02e9bf970",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ad607f2-a5c1-45dc-88e3-92b5e108ea82",
"db_currency_id": "2eb751cb-aa9f-4605-b8ae-2d6b91069f68",
"db_language_id": "3fc5f44a-f9b8-4a08-a72e-b494d0598772",
"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-17T07:42:54.0338065+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-17T07:42:54.0338065+00:00"
},
"company_id": "19df2e7e-461c-4643-bb67-ff02776ec51e",
"company_code": "sample string 12",
"db_address_id": "5e1d4ba0-0f95-4612-9402-eb8ff5a8aed8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c36538a0-3a69-4859-9928-db6a1a5809fe",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7ac762f8-6419-4493-b4a0-cf614d243383",
"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-17T07:42:54.0338065+00:00",
"date_create": "2026-06-17T07:42:54.0338065+00:00",
"date_update": "2026-06-17T07:42:54.0338065+00:00",
"updated_by_user_id": "b819eca9-d3f0-4615-8396-36babd1600e4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-17T07:42:54.0338065+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-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-17T07:42:54.0338065+00:00",
"date_last_job": "2026-06-17T07:42:54.0338065+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-17T07:42:54.0338065+00:00",
"modified_dateutc": "2026-06-17T07:42:54.0338065+00:00",
"is_mobile_installation": true
},
"job_type_id": "37609967-a850-4cca-902e-63182aa87206",
"job_type_code": "sample string 7",
"job_type": {
"id": "5a2aa44e-8f9b-48d1-bd33-e0bdd4fe1290",
"name": "sample string 2",
"sales_organization_id": "882ce00f-733b-49f1-b4ac-df0bddb4647f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-17T07:42:54.0338065+00:00",
"code": "sample string 7"
},
"job_priority_id": "7135c714-6ae0-4f19-a6af-ac840c2efdec",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0a548b26-b4dd-42e8-a901-81726142a2c1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d1bd3b5d-e85f-455b-9ca1-1d28d257a156",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "23d0c02e-26ce-49a3-bc8d-f8b02e9bf970",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ad607f2-a5c1-45dc-88e3-92b5e108ea82",
"db_currency_id": "2eb751cb-aa9f-4605-b8ae-2d6b91069f68",
"db_language_id": "3fc5f44a-f9b8-4a08-a72e-b494d0598772",
"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-17T07:42:54.0338065+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-17T07:42:54.0338065+00:00"
},
"job_status_id": "a196bebc-6327-4567-8388-3ba131434636",
"job_status_code": "sample string 11",
"db_address_id": "8e1fcf95-5324-4d1f-806f-8e9b1c504761",
"contact_id": "07934fb7-7b4a-4d60-a715-0aab59821ec9",
"requested_by_company_id": "07a4b21d-3d16-4383-b64a-44136bf54680",
"requested_by_contact_id": "9722fcae-37ac-4bd5-b1c5-b2d0b7d16760",
"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-17T07:42:54.0338065+00:00",
"due_date": "2026-06-17T07:42:54.0338065+00:00",
"date_create": "2026-06-17T07:42:54.0338065+00:00",
"date_update": "2026-06-17T07:42:54.0338065+00:00",
"date_closed": "2026-06-17T07:42:54.0338065+00:00",
"suggested_user_id": "afdff51d-8ae5-4735-b1e8-ce4a75f36652",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1ba7320b-b39e-4fde-89cb-277dd79e72a6",
"db_language_id": "7016053c-e35f-4a65-a32a-8cc5ef1a5990",
"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-17T07:42:54.0338065+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7f375c2d-2dc1-4038-9988-3b1c37bee0f2",
"sales_organization": {
"id": "23d0c02e-26ce-49a3-bc8d-f8b02e9bf970",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ad607f2-a5c1-45dc-88e3-92b5e108ea82",
"db_currency_id": "2eb751cb-aa9f-4605-b8ae-2d6b91069f68",
"db_language_id": "3fc5f44a-f9b8-4a08-a72e-b494d0598772",
"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-17T07:42:54.0338065+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e6e1ffd7-096b-4bd9-897f-8ddd6f158ad4",
"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": "9159e128-bd06-434a-a636-db0a4ef91faa",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-17T07:42:54.0338065+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "56c6ac07-3ade-42b3-a47f-40cc57e09e54"
},
"suggested_date_start": "2026-06-17T07:42:54.0338065+00:00",
"skill_id": "90946d11-1260-42f1-8bee-16f3e5745d50",
"skill_code": "sample string 32",
"skill": {
"id": "d7982920-e0a2-4b0a-b694-f8fdb0935c72",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "13c91cf0-8960-49b8-bb01-e6082f8bd3ac",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "23d0c02e-26ce-49a3-bc8d-f8b02e9bf970",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ad607f2-a5c1-45dc-88e3-92b5e108ea82",
"db_currency_id": "2eb751cb-aa9f-4605-b8ae-2d6b91069f68",
"db_language_id": "3fc5f44a-f9b8-4a08-a72e-b494d0598772",
"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-17T07:42:54.0338065+00:00"
},
"modified_dateutc": "2026-06-17T07:42:54.0338065+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0b34eca9-9671-4b62-a35d-31885148a2df",
"date_reported_by_company": "2026-06-17T07:42:54.0338065+00:00",
"id2": 36,
"company_id": "3e0f401e-e0af-4f71-9f51-a7784b38bddb",
"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": "9cdd5c19-aa8e-41e3-bb03-dbded9135037",
"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-17T07:42:54.0338065+00:00"
},
"work_instruction_details_id": "dd6a09a3-fcc2-4bde-af17-67e5634ca52d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "29f183ae-1552-4ce7-9490-1f53105544c8",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "cbe278b9-056d-49f9-8ad5-3210f29f20ec",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-17T07:42:54.0338065+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": "1d015661-14c6-450b-b58c-f7c6bdb7cd83",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-17T07:42:54.0338065+00:00"
}