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
{
"id": "3b4aa053-376e-4ce7-9d89-f730d86e0301",
"jobs_id": "761f0f50-5001-437b-baae-4e907e10ccbd",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "653cb69c-f4ac-4d66-8965-0582defcec8c",
"_parent_id": "07534368-e10e-4863-9b06-9a2920dafac6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f05e71f9-f99f-41ce-ac7c-ea6205755e34",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8eb2b1f7-bf4d-470b-a6d9-df4933bfc6c6",
"_parent_id": "fd5823f4-796c-4dbc-ab3e-b1a58bc22e70",
"root_parent_id": "e9c21e9e-6e56-4e44-bce7-4910082c57fd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "27d9fbfd-fbd2-4f4f-8483-b37d801bcbef",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "99ce6e53-72b4-46a3-8fc1-8dbe4857d305",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dabd54a1-bc01-4810-9655-2ae7bf1c3b07",
"_parent_code": "sample string 6",
"sales_organization_id": "3e475d32-745d-4749-871c-37a258771e1d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4121cc81-5f6d-4adf-b240-c109978364c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cd5662e4-5eef-49b5-b544-9a719a4ff1de",
"db_currency_id": "2f328c95-fc60-4b32-a655-454c46f299e9",
"db_language_id": "5a3c974e-93a8-4233-a0d4-cdd0cc1e2917",
"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-11-16T20:56:43.648803+00:00"
},
"modified_dateutc": "2026-11-16T20:56:43.648803+00:00"
},
"equipment_model_id": "59b10b68-e93b-4ff4-aa0f-1983eec116b6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "20df1841-bf38-46d9-a85f-15d46f2b76bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "bdbc3520-9ac7-423b-9cfa-87a9424df62b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f9271ce5-628e-4c94-bcdb-24fc81cf8acc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e48594d2-be46-4637-95c5-0f8339dd1c7b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4121cc81-5f6d-4adf-b240-c109978364c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cd5662e4-5eef-49b5-b544-9a719a4ff1de",
"db_currency_id": "2f328c95-fc60-4b32-a655-454c46f299e9",
"db_language_id": "5a3c974e-93a8-4233-a0d4-cdd0cc1e2917",
"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-11-16T20:56:43.648803+00:00"
},
"modified_dateutc": "2026-11-16T20:56:43.648803+00:00"
},
"equipment_family_id": "c954e54f-a317-4da7-803e-5319ce712332",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "99ce6e53-72b4-46a3-8fc1-8dbe4857d305",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dabd54a1-bc01-4810-9655-2ae7bf1c3b07",
"_parent_code": "sample string 6",
"sales_organization_id": "3e475d32-745d-4749-871c-37a258771e1d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4121cc81-5f6d-4adf-b240-c109978364c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cd5662e4-5eef-49b5-b544-9a719a4ff1de",
"db_currency_id": "2f328c95-fc60-4b32-a655-454c46f299e9",
"db_language_id": "5a3c974e-93a8-4233-a0d4-cdd0cc1e2917",
"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-11-16T20:56:43.648803+00:00"
},
"modified_dateutc": "2026-11-16T20:56:43.648803+00:00"
},
"date_in_production_since": "2026-11-16T20:56:43.648803+00:00",
"date_out_of_production_since": "2026-11-16T20:56:43.648803+00:00",
"date_end_support": "2026-11-16T20:56:43.648803+00:00",
"sales_organization_id": "e4f51b9b-4f37-4bd3-88fc-7771d48a1fe6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4121cc81-5f6d-4adf-b240-c109978364c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cd5662e4-5eef-49b5-b544-9a719a4ff1de",
"db_currency_id": "2f328c95-fc60-4b32-a655-454c46f299e9",
"db_language_id": "5a3c974e-93a8-4233-a0d4-cdd0cc1e2917",
"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-11-16T20:56:43.648803+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-11-16T20:56:43.648803+00:00"
},
"project_status_id": "bea6c315-0a80-433c-855a-19b9b592001d",
"project_status_code": "sample string 10",
"project_status": {
"id": "d5951901-07aa-4787-a0fb-04776608e311",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "366d6c80-14c7-4475-81e2-d25737ed75fe",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4121cc81-5f6d-4adf-b240-c109978364c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cd5662e4-5eef-49b5-b544-9a719a4ff1de",
"db_currency_id": "2f328c95-fc60-4b32-a655-454c46f299e9",
"db_language_id": "5a3c974e-93a8-4233-a0d4-cdd0cc1e2917",
"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-11-16T20:56:43.648803+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-16T20:56:43.648803+00:00"
},
"company_id": "8b1a84ac-3d6b-4f1e-80f0-3b80272df0dc",
"company_code": "sample string 12",
"db_address_id": "488a3566-a09b-4048-8e29-67e8e0642abf",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a016950d-86e4-4e99-a81e-1a76ddc15bb5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "64812278-df63-46e6-b1ae-51b5ee934ed2",
"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-11-16T20:56:43.648803+00:00",
"date_create": "2026-11-16T20:56:43.648803+00:00",
"date_update": "2026-11-16T20:56:43.648803+00:00",
"updated_by_user_id": "79100646-0bde-45ec-9daa-5b87e68c07e4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-16T20:56:43.648803+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-11-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-16T20:56:43.648803+00:00",
"date_last_job": "2026-11-16T20:56:43.648803+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-16T20:56:43.648803+00:00",
"modified_dateutc": "2026-11-16T20:56:43.648803+00:00",
"is_mobile_installation": true
},
"job_type_id": "3dbe2dbf-1b6a-496b-b061-aa817d0d53d0",
"job_type_code": "sample string 7",
"job_type": {
"id": "414ddf70-38b3-416e-8757-0545b50f3f85",
"name": "sample string 2",
"sales_organization_id": "692bdadb-3d0e-45ae-896c-40cdbbaa4c8b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-16T20:56:43.648803+00:00",
"code": "sample string 7"
},
"job_priority_id": "9b353016-75b5-46c5-a6e1-f6fad8fe6880",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "32950113-4ee0-4688-84e5-9c4e99be19db",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "32164af3-2310-4e39-89f2-c58ec30e3883",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4121cc81-5f6d-4adf-b240-c109978364c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cd5662e4-5eef-49b5-b544-9a719a4ff1de",
"db_currency_id": "2f328c95-fc60-4b32-a655-454c46f299e9",
"db_language_id": "5a3c974e-93a8-4233-a0d4-cdd0cc1e2917",
"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-11-16T20:56:43.648803+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-16T20:56:43.648803+00:00"
},
"job_status_id": "0cba3387-abaa-46ff-a174-87d5bc5ee16d",
"job_status_code": "sample string 11",
"db_address_id": "21b969e4-a45f-426c-87e1-48595ee1ca48",
"contact_id": "a9ebcd6b-fd64-437d-81fe-eddd5e4f9bb3",
"requested_by_company_id": "83119636-e07a-4ccc-983f-2b5fd077cecc",
"requested_by_contact_id": "f1444e18-0ed5-41e8-9408-da8f8a943d81",
"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-11-16T20:56:43.648803+00:00",
"due_date": "2026-11-16T20:56:43.648803+00:00",
"date_create": "2026-11-16T20:56:43.6680107+00:00",
"date_update": "2026-11-16T20:56:43.6680107+00:00",
"date_closed": "2026-11-16T20:56:43.6680107+00:00",
"suggested_user_id": "d442ff83-9578-4bdd-a428-a33e30c869de",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "196a4859-5eed-4b98-91b1-7944fbf36bc1",
"db_language_id": "1e26770c-cee6-47ca-a00a-f79556a71c82",
"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-11-16T20:56:43.6680107+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7fe2d8f6-9dd9-429c-b612-d9748daf7f7c",
"sales_organization": {
"id": "4121cc81-5f6d-4adf-b240-c109978364c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cd5662e4-5eef-49b5-b544-9a719a4ff1de",
"db_currency_id": "2f328c95-fc60-4b32-a655-454c46f299e9",
"db_language_id": "5a3c974e-93a8-4233-a0d4-cdd0cc1e2917",
"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-11-16T20:56:43.648803+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "aac6f2d1-0bea-44d8-9da8-3725187e109c",
"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": "4dda6b2d-8fbd-4d53-9b3d-7d3fd09a8486",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-16T20:56:43.6680107+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b8b59648-6861-4c6a-92a3-90d2ccf70517"
},
"suggested_date_start": "2026-11-16T20:56:43.6680107+00:00",
"skill_id": "c3d0c399-6275-4586-8f83-6c554527733d",
"skill_code": "sample string 32",
"skill": {
"id": "407c0049-0d49-4949-bf46-82e9d683c357",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "279f198c-d59e-4444-b999-d804840174bb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4121cc81-5f6d-4adf-b240-c109978364c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cd5662e4-5eef-49b5-b544-9a719a4ff1de",
"db_currency_id": "2f328c95-fc60-4b32-a655-454c46f299e9",
"db_language_id": "5a3c974e-93a8-4233-a0d4-cdd0cc1e2917",
"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-11-16T20:56:43.648803+00:00"
},
"modified_dateutc": "2026-11-16T20:56:43.6680107+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c2c46930-8310-45a8-a35a-429e5e150805",
"date_reported_by_company": "2026-11-16T20:56:43.6680107+00:00",
"id2": 36,
"company_id": "dda3206a-4ddb-4f15-974c-c02c98ad73a9",
"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": "b934a206-ff2d-454c-90d0-983a5bf852e1",
"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-11-16T20:56:43.6680107+00:00"
},
"work_instruction_details_id": "7bfbdbc3-e019-493a-b69a-356dc70f20d4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "5423dfcd-7946-4135-b7cd-dd1f23af5dd3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "62bbe0f4-b6d9-4e71-bba6-4ac9779a646a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-16T20:56:43.6680107+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": "a2e435d3-f9f9-44d7-b973-e8e8cb17b074",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-16T20:56:43.6680107+00:00"
}