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": "e8b8b6d8-9147-47ed-a8e8-4725069c2f74",
"jobs_id": "e1e31e15-cdac-47aa-8602-47ad349de491",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f853213a-8b0a-49d9-a4db-ebedaf02336a",
"_parent_id": "49fcb2a4-d4f1-4fc3-b209-b2944596c33b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e4e5c958-a44e-460a-b84a-e24f7217ef5a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "76d3547d-15cf-4c77-8b6d-b1828fc082f5",
"_parent_id": "68adf9a0-c38e-4837-acd2-6bbc48425be6",
"root_parent_id": "a0ab79cf-7426-4f21-82e1-7c7f887b9b3e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c0f361f6-1357-42d9-9ef2-e8ccee67bd0f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "00373e3b-2eeb-4a58-93e8-7e2c950ea0b6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "49568e26-77e9-4aec-a50a-1499a8c54943",
"_parent_code": "sample string 6",
"sales_organization_id": "58379e1a-901c-4f4d-9551-c2e261a60cec",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "df6476c3-6d0f-49d7-82c7-e42ad51be81d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0653dc0-d7dc-4c3e-9da3-97811d3fee82",
"db_currency_id": "e8da4928-a1d7-4469-8640-54c28f2b1e8d",
"db_language_id": "85c6ce02-b720-407b-bcd0-6cc67ef57f1f",
"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-02-03T21:05:17.4724845+00:00"
},
"modified_dateutc": "2026-02-03T21:05:17.4724845+00:00"
},
"equipment_model_id": "ba399e31-f264-40e8-9562-e844642d7bbc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ffaa4875-2d5c-4d22-b2a8-0f65d684bca3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b54824b7-6f0f-4139-a265-15a8152526f7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "db275ec0-881a-48ca-bd4e-99a09dd58971",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "db826d27-6ba8-46d9-97f4-0bc0c3bed490",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "df6476c3-6d0f-49d7-82c7-e42ad51be81d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0653dc0-d7dc-4c3e-9da3-97811d3fee82",
"db_currency_id": "e8da4928-a1d7-4469-8640-54c28f2b1e8d",
"db_language_id": "85c6ce02-b720-407b-bcd0-6cc67ef57f1f",
"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-02-03T21:05:17.4724845+00:00"
},
"modified_dateutc": "2026-02-03T21:05:17.4724845+00:00"
},
"equipment_family_id": "6107006e-c453-45fa-9113-20b9b95ef25e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "00373e3b-2eeb-4a58-93e8-7e2c950ea0b6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "49568e26-77e9-4aec-a50a-1499a8c54943",
"_parent_code": "sample string 6",
"sales_organization_id": "58379e1a-901c-4f4d-9551-c2e261a60cec",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "df6476c3-6d0f-49d7-82c7-e42ad51be81d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0653dc0-d7dc-4c3e-9da3-97811d3fee82",
"db_currency_id": "e8da4928-a1d7-4469-8640-54c28f2b1e8d",
"db_language_id": "85c6ce02-b720-407b-bcd0-6cc67ef57f1f",
"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-02-03T21:05:17.4724845+00:00"
},
"modified_dateutc": "2026-02-03T21:05:17.4724845+00:00"
},
"date_in_production_since": "2026-02-03T21:05:17.4724845+00:00",
"date_out_of_production_since": "2026-02-03T21:05:17.4724845+00:00",
"date_end_support": "2026-02-03T21:05:17.4724845+00:00",
"sales_organization_id": "24d4f996-907a-418e-a92d-5858a5e5e0e3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "df6476c3-6d0f-49d7-82c7-e42ad51be81d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0653dc0-d7dc-4c3e-9da3-97811d3fee82",
"db_currency_id": "e8da4928-a1d7-4469-8640-54c28f2b1e8d",
"db_language_id": "85c6ce02-b720-407b-bcd0-6cc67ef57f1f",
"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-02-03T21:05:17.4724845+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-02-03T21:05:17.4724845+00:00"
},
"project_status_id": "0e3ad084-0cb5-4393-9882-46f82cab2799",
"project_status_code": "sample string 10",
"project_status": {
"id": "590e80c8-aa57-4098-a66c-9df6d06aa346",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bd9d1355-f515-42a4-81ed-b1985fe26f96",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "df6476c3-6d0f-49d7-82c7-e42ad51be81d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0653dc0-d7dc-4c3e-9da3-97811d3fee82",
"db_currency_id": "e8da4928-a1d7-4469-8640-54c28f2b1e8d",
"db_language_id": "85c6ce02-b720-407b-bcd0-6cc67ef57f1f",
"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-02-03T21:05:17.4724845+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-03T21:05:17.4724845+00:00"
},
"company_id": "e9625a46-c576-4f03-ac35-9f7a10242623",
"company_code": "sample string 12",
"db_address_id": "e18c15a0-a135-4bb6-addf-f9566458c3fd",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8b3beeaf-83ae-4af3-b7c9-cb6bb73f94c8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d8b0a6ce-fcf3-4d94-a10a-cfaff4ab4392",
"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-02-03T21:05:17.4724845+00:00",
"date_create": "2026-02-03T21:05:17.4724845+00:00",
"date_update": "2026-02-03T21:05:17.4724845+00:00",
"updated_by_user_id": "d2ecf9a7-e301-4c62-a690-2473a33750df",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-03T21:05:17.4724845+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-02-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-03T21:05:17.4724845+00:00",
"date_last_job": "2026-02-03T21:05:17.4724845+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-03T21:05:17.4724845+00:00",
"modified_dateutc": "2026-02-03T21:05:17.4724845+00:00",
"is_mobile_installation": true
},
"job_type_id": "1dc0e288-6d68-4fd6-b9b7-3f42c43d7063",
"job_type_code": "sample string 7",
"job_type": {
"id": "bf4b4a17-2500-4fbe-8ef0-3e003044f26a",
"name": "sample string 2",
"sales_organization_id": "389b84da-99d6-4d62-b790-bfbe7d70f7ae",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-03T21:05:17.4724845+00:00",
"code": "sample string 7"
},
"job_priority_id": "f3e730b0-4b6d-453f-879e-0f0a66db366e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "417c8d62-3a9e-456f-9607-71eee109a4b8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "68a6ec68-2ee3-4f91-b02c-6bd2aaee5ecb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "df6476c3-6d0f-49d7-82c7-e42ad51be81d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0653dc0-d7dc-4c3e-9da3-97811d3fee82",
"db_currency_id": "e8da4928-a1d7-4469-8640-54c28f2b1e8d",
"db_language_id": "85c6ce02-b720-407b-bcd0-6cc67ef57f1f",
"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-02-03T21:05:17.4724845+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-03T21:05:17.4724845+00:00"
},
"job_status_id": "095fc66e-6d09-4e2d-8f06-2be7b2df4df2",
"job_status_code": "sample string 11",
"db_address_id": "0703041f-9e78-43dc-965f-f09b3e360f1b",
"contact_id": "12d34174-eca4-435a-8cbd-afe8b9a298ed",
"requested_by_company_id": "220b320f-586b-4fae-b834-a29b1ebfcab6",
"requested_by_contact_id": "dbb25406-cd16-43e2-9eb1-f99ddb6e7733",
"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-02-03T21:05:17.4724845+00:00",
"due_date": "2026-02-03T21:05:17.4724845+00:00",
"date_create": "2026-02-03T21:05:17.4724845+00:00",
"date_update": "2026-02-03T21:05:17.4724845+00:00",
"date_closed": "2026-02-03T21:05:17.4724845+00:00",
"suggested_user_id": "c3fc2aa9-7d3d-4675-9208-0ac90bc91c88",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "90285684-9710-488f-b38a-f4c31880efc0",
"db_language_id": "55bc4fe1-104c-4c4c-a0cd-2992f15d09cd",
"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-02-03T21:05:17.4724845+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8f03e7b2-e3e5-453a-9c70-46ab6c43cc30",
"sales_organization": {
"id": "df6476c3-6d0f-49d7-82c7-e42ad51be81d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0653dc0-d7dc-4c3e-9da3-97811d3fee82",
"db_currency_id": "e8da4928-a1d7-4469-8640-54c28f2b1e8d",
"db_language_id": "85c6ce02-b720-407b-bcd0-6cc67ef57f1f",
"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-02-03T21:05:17.4724845+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "39bbd2a8-3715-4989-a4c2-52fa299370c2",
"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": "e50cbc15-af46-41af-a9d5-6dd0f12a96b1",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-03T21:05:17.4724845+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ed43490f-9653-4d38-ad2b-ce7f15425686"
},
"suggested_date_start": "2026-02-03T21:05:17.4724845+00:00",
"skill_id": "80310d70-f75d-4186-a9be-f15ea5b2daa7",
"skill_code": "sample string 32",
"skill": {
"id": "8a60e17d-e62e-4a63-86eb-733f10ff178a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d241d377-40e6-4b83-a681-85b7b7afbefc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "df6476c3-6d0f-49d7-82c7-e42ad51be81d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d0653dc0-d7dc-4c3e-9da3-97811d3fee82",
"db_currency_id": "e8da4928-a1d7-4469-8640-54c28f2b1e8d",
"db_language_id": "85c6ce02-b720-407b-bcd0-6cc67ef57f1f",
"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-02-03T21:05:17.4724845+00:00"
},
"modified_dateutc": "2026-02-03T21:05:17.4724845+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7fd96fd7-2238-4a9c-8d47-70d9d5e8a365",
"date_reported_by_company": "2026-02-03T21:05:17.4724845+00:00",
"id2": 36,
"company_id": "179946b6-779d-4607-b16c-e92c7dea2310",
"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": "58403b87-460a-4bea-b2f4-a1e8e579694a",
"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-02-03T21:05:17.4724845+00:00"
},
"work_instruction_details_id": "dad2d88e-b461-450f-ab69-08716b5f1bb8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8803b097-ac71-4e94-8274-8f975c677883",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9df987be-9a4e-4cf8-bd15-65f7910511aa",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-03T21:05:17.4724845+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": "b83625fc-ace9-494a-a131-9a8dbb7b9390",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-03T21:05:17.4724845+00:00"
}