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": "b5370947-876c-4762-8055-81af8a37a5a6",
"jobs_id": "914ae14d-0e82-4902-a7da-02af2f4676d7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5d907bad-71f9-43ef-b61e-08c4f7c3d497",
"_parent_id": "65d6dc05-00a5-4ec6-b0c6-98c8a0c0022c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "dae96170-e164-4abb-9341-e53e1e44a85c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6c5edc95-503b-4ce2-8541-c69e33ea7aa6",
"_parent_id": "31bbe335-6eed-4331-a00a-772efcac1e4f",
"root_parent_id": "9e9fa286-766f-4660-b9dc-67c8fc4c9955",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6f6462ff-763b-4475-83c4-b7e73dbb7fde",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "47cacaa7-13ba-4dd3-895e-3d32664b72f1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b43e3b6a-5116-4d4b-821c-2e6e0ae41dfa",
"_parent_code": "sample string 6",
"sales_organization_id": "7c041dc9-afe9-458b-b84d-76ce27bb6999",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9d169455-5eb4-4425-8a78-28bd9e58095c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3809dfdd-5172-4a2e-b540-e95fd5e87f6e",
"db_currency_id": "48de70e3-f81e-4b2c-a668-87c66d9a01bc",
"db_language_id": "b3b74197-e669-4d88-b41c-a18e46e3d7a7",
"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": "2025-11-29T01:26:55.8502597+00:00"
},
"modified_dateutc": "2025-11-29T01:26:55.8502597+00:00"
},
"equipment_model_id": "76f255fb-026a-4dff-9df0-b820367e1970",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6ff98afb-8244-49f6-8803-8ca54de405fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7af53c25-1b9e-4df2-b9a2-a1f1abc648d1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1c882c2e-9972-476f-ae4e-88c2e564b995",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "39d5df93-2392-4e82-8893-4af8aad3feb2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9d169455-5eb4-4425-8a78-28bd9e58095c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3809dfdd-5172-4a2e-b540-e95fd5e87f6e",
"db_currency_id": "48de70e3-f81e-4b2c-a668-87c66d9a01bc",
"db_language_id": "b3b74197-e669-4d88-b41c-a18e46e3d7a7",
"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": "2025-11-29T01:26:55.8502597+00:00"
},
"modified_dateutc": "2025-11-29T01:26:55.8502597+00:00"
},
"equipment_family_id": "8db9021a-771f-45fc-ab52-981d11db6e3e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "47cacaa7-13ba-4dd3-895e-3d32664b72f1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b43e3b6a-5116-4d4b-821c-2e6e0ae41dfa",
"_parent_code": "sample string 6",
"sales_organization_id": "7c041dc9-afe9-458b-b84d-76ce27bb6999",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9d169455-5eb4-4425-8a78-28bd9e58095c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3809dfdd-5172-4a2e-b540-e95fd5e87f6e",
"db_currency_id": "48de70e3-f81e-4b2c-a668-87c66d9a01bc",
"db_language_id": "b3b74197-e669-4d88-b41c-a18e46e3d7a7",
"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": "2025-11-29T01:26:55.8502597+00:00"
},
"modified_dateutc": "2025-11-29T01:26:55.8502597+00:00"
},
"date_in_production_since": "2025-11-29T01:26:55.8502597+00:00",
"date_out_of_production_since": "2025-11-29T01:26:55.8502597+00:00",
"date_end_support": "2025-11-29T01:26:55.8502597+00:00",
"sales_organization_id": "15afaf50-b63e-4922-8612-546a1a5ace5f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9d169455-5eb4-4425-8a78-28bd9e58095c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3809dfdd-5172-4a2e-b540-e95fd5e87f6e",
"db_currency_id": "48de70e3-f81e-4b2c-a668-87c66d9a01bc",
"db_language_id": "b3b74197-e669-4d88-b41c-a18e46e3d7a7",
"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": "2025-11-29T01:26:55.8502597+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": "2025-11-29T01:26:55.8502597+00:00"
},
"project_status_id": "d5bccbde-d15f-4195-84d9-be4b203f6ac6",
"project_status_code": "sample string 10",
"project_status": {
"id": "29598fe9-2afb-4595-afe1-d1a3e46d23e9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1ff7e8ea-366b-438c-8de7-84d1614dbdbb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9d169455-5eb4-4425-8a78-28bd9e58095c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3809dfdd-5172-4a2e-b540-e95fd5e87f6e",
"db_currency_id": "48de70e3-f81e-4b2c-a668-87c66d9a01bc",
"db_language_id": "b3b74197-e669-4d88-b41c-a18e46e3d7a7",
"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": "2025-11-29T01:26:55.8502597+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-29T01:26:55.8502597+00:00"
},
"company_id": "87f7aa6f-e293-4c82-925c-5d0bd158eeda",
"company_code": "sample string 12",
"db_address_id": "447ecebe-97d6-4c6a-8a08-94c23b53b298",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "20a34449-0258-40bd-94f7-fb58f17aaf44",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3d995b8d-57b0-42fc-ac8a-86720b0b1fcd",
"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": "2025-11-29T01:26:55.8502597+00:00",
"date_create": "2025-11-29T01:26:55.8502597+00:00",
"date_update": "2025-11-29T01:26:55.8502597+00:00",
"updated_by_user_id": "53df7989-865e-4218-b21a-be5ede95f2d1",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-29T01:26:55.8502597+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": "2025-11-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-29T01:26:55.8502597+00:00",
"date_last_job": "2025-11-29T01:26:55.8502597+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-29T01:26:55.8502597+00:00",
"modified_dateutc": "2025-11-29T01:26:55.8502597+00:00",
"is_mobile_installation": true
},
"job_type_id": "f0e80b2a-4cba-47c5-8f22-7c63fc01c887",
"job_type_code": "sample string 7",
"job_type": {
"id": "a426d48e-348d-402c-9bd6-40c49e183f0b",
"name": "sample string 2",
"sales_organization_id": "308455d4-767e-42cb-9cc8-d171cdb2c842",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-29T01:26:55.8502597+00:00",
"code": "sample string 7"
},
"job_priority_id": "8a7ad7fe-d413-4dc2-97ca-6b6fe78d3785",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1d85edfd-9163-411a-975f-0feef3f17e05",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "997bd9ed-6d5d-40d2-b962-0b0b7fa3f816",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9d169455-5eb4-4425-8a78-28bd9e58095c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3809dfdd-5172-4a2e-b540-e95fd5e87f6e",
"db_currency_id": "48de70e3-f81e-4b2c-a668-87c66d9a01bc",
"db_language_id": "b3b74197-e669-4d88-b41c-a18e46e3d7a7",
"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": "2025-11-29T01:26:55.8502597+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-29T01:26:55.8502597+00:00"
},
"job_status_id": "8b3cbfa1-932e-42f3-8d58-38fdc12b6655",
"job_status_code": "sample string 11",
"db_address_id": "b4f0b366-6a32-40b1-ab51-7108f5457d5e",
"contact_id": "f4443551-f14f-46cd-85b0-ac44ceaf1dca",
"requested_by_company_id": "a9988b85-47f3-455a-aee1-a440cdadbbe7",
"requested_by_contact_id": "f8f52c0c-dc4f-40c7-a6db-e850cde3fbe7",
"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": "2025-11-29T01:26:55.8502597+00:00",
"due_date": "2025-11-29T01:26:55.8502597+00:00",
"date_create": "2025-11-29T01:26:55.8502597+00:00",
"date_update": "2025-11-29T01:26:55.8502597+00:00",
"date_closed": "2025-11-29T01:26:55.8502597+00:00",
"suggested_user_id": "2f9cf646-dab5-49e2-8429-1d7e3a074342",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d69ef1f4-858c-4139-acbd-3dc15e2992d4",
"db_language_id": "31b0d670-d8a9-4142-8b23-75b89c78c835",
"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": "2025-11-29T01:26:55.8502597+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ce1fdf30-56e6-4177-a9af-b492c0f9a7e1",
"sales_organization": {
"id": "9d169455-5eb4-4425-8a78-28bd9e58095c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3809dfdd-5172-4a2e-b540-e95fd5e87f6e",
"db_currency_id": "48de70e3-f81e-4b2c-a668-87c66d9a01bc",
"db_language_id": "b3b74197-e669-4d88-b41c-a18e46e3d7a7",
"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": "2025-11-29T01:26:55.8502597+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7860d2f0-eb2d-41d2-b4dc-2062b443c5e8",
"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": "7cbb404f-85cc-4aa3-989f-c562ad4edd33",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-29T01:26:55.8502597+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6dba2400-9132-4152-8561-575d36b72f23"
},
"suggested_date_start": "2025-11-29T01:26:55.8502597+00:00",
"skill_id": "fb421d69-4c91-4e42-ba4b-c97e282150d1",
"skill_code": "sample string 32",
"skill": {
"id": "a3000355-485a-4d4e-828f-73bc564afdd6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "715a2dd1-939b-43d9-acd5-41a240c49323",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9d169455-5eb4-4425-8a78-28bd9e58095c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3809dfdd-5172-4a2e-b540-e95fd5e87f6e",
"db_currency_id": "48de70e3-f81e-4b2c-a668-87c66d9a01bc",
"db_language_id": "b3b74197-e669-4d88-b41c-a18e46e3d7a7",
"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": "2025-11-29T01:26:55.8502597+00:00"
},
"modified_dateutc": "2025-11-29T01:26:55.8502597+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "87267f76-f59b-43c2-a694-ed5016c94f33",
"date_reported_by_company": "2025-11-29T01:26:55.8502597+00:00",
"id2": 36,
"company_id": "47767877-b68e-4fdf-a873-95d8589fb7c9",
"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": "ae871486-2090-423d-b1af-22bac8c9d31e",
"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": "2025-11-29T01:26:55.8502597+00:00"
},
"work_instruction_details_id": "bd028f9f-c7e5-4076-bbc4-802677ec3e42",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7b6dfd73-6c44-4542-833b-ee107e5873e1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b9d858c7-742e-4168-ac03-7e9cb5cc978d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-29T01:26:55.8502597+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": "455196b2-c217-4b4d-8d45-ce186f8d8e53",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-29T01:26:55.8502597+00:00"
}