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": "cf177c34-0849-4123-b82a-12e6df67e61a",
"jobs_id": "4270cd20-eda7-49c5-9bed-52abd1c0610d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b93b3b2a-0115-496f-bcf7-5b7930bd666b",
"_parent_id": "74e9e98a-7b04-45ff-b113-adc9ef9b6ecd",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cfa15fbe-9a26-4408-a00d-92c17c66f2d1",
"project_reference_back_office": "sample string 5",
"project": {
"id": "dbab3a16-7bfe-480d-a910-5d88ffba0a06",
"_parent_id": "5a7b082d-ec18-48da-b4be-5f144f34d6ad",
"root_parent_id": "85879a93-418a-4303-8086-6a8df8044f06",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c51dd653-3c3b-4298-bb93-9ff61ae1794b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7d46ffc6-d842-4936-ae94-6d6364cfde20",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5733ba42-e672-41f7-809b-cf926158cacf",
"_parent_code": "sample string 6",
"sales_organization_id": "c8d26a91-a313-443b-a85b-f7b1534264f7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a8d89c1e-1850-442d-84cb-acc91ed96ffc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a27afde-c7e5-4dad-b348-b1c58cf16b44",
"db_currency_id": "3064712d-c1a0-4bed-a620-b7894dbdfee6",
"db_language_id": "d2d756cd-7a4e-4049-90d3-2f6cb8e18e63",
"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-25T01:29:01.3633767+00:00"
},
"modified_dateutc": "2026-05-25T01:29:01.3633767+00:00"
},
"equipment_model_id": "293b8637-1d92-4fe4-a894-421cd5e968d3",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4b9e3b8e-8170-4e6b-8487-b17f5fca01fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ad7cec81-272b-4206-9801-0c4a1910dab5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "51c962b5-5802-4c30-a1b9-91f89f8960fb",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1c2c8f8a-ece2-462d-8801-e10469c55fcc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a8d89c1e-1850-442d-84cb-acc91ed96ffc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a27afde-c7e5-4dad-b348-b1c58cf16b44",
"db_currency_id": "3064712d-c1a0-4bed-a620-b7894dbdfee6",
"db_language_id": "d2d756cd-7a4e-4049-90d3-2f6cb8e18e63",
"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-25T01:29:01.3633767+00:00"
},
"modified_dateutc": "2026-05-25T01:29:01.3633767+00:00"
},
"equipment_family_id": "3faf930c-d2b3-4735-b341-9f45ff3636f5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7d46ffc6-d842-4936-ae94-6d6364cfde20",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5733ba42-e672-41f7-809b-cf926158cacf",
"_parent_code": "sample string 6",
"sales_organization_id": "c8d26a91-a313-443b-a85b-f7b1534264f7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a8d89c1e-1850-442d-84cb-acc91ed96ffc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a27afde-c7e5-4dad-b348-b1c58cf16b44",
"db_currency_id": "3064712d-c1a0-4bed-a620-b7894dbdfee6",
"db_language_id": "d2d756cd-7a4e-4049-90d3-2f6cb8e18e63",
"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-25T01:29:01.3633767+00:00"
},
"modified_dateutc": "2026-05-25T01:29:01.3633767+00:00"
},
"date_in_production_since": "2026-05-25T01:29:01.3633767+00:00",
"date_out_of_production_since": "2026-05-25T01:29:01.3633767+00:00",
"date_end_support": "2026-05-25T01:29:01.3633767+00:00",
"sales_organization_id": "d8a28dad-f4ba-44e7-8ffa-586db07e5a00",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a8d89c1e-1850-442d-84cb-acc91ed96ffc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a27afde-c7e5-4dad-b348-b1c58cf16b44",
"db_currency_id": "3064712d-c1a0-4bed-a620-b7894dbdfee6",
"db_language_id": "d2d756cd-7a4e-4049-90d3-2f6cb8e18e63",
"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-25T01:29:01.3633767+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-25T01:29:01.3789988+00:00"
},
"project_status_id": "62bd6854-649b-4ea1-828c-1d514e1ab03e",
"project_status_code": "sample string 10",
"project_status": {
"id": "adecb329-5f1b-4b69-b36c-6bb2a59bb5cb",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f08e1486-c15c-4a35-95c8-2409fabdc9c1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a8d89c1e-1850-442d-84cb-acc91ed96ffc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a27afde-c7e5-4dad-b348-b1c58cf16b44",
"db_currency_id": "3064712d-c1a0-4bed-a620-b7894dbdfee6",
"db_language_id": "d2d756cd-7a4e-4049-90d3-2f6cb8e18e63",
"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-25T01:29:01.3633767+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-25T01:29:01.3789988+00:00"
},
"company_id": "a448be2f-43dc-43d1-a1e3-6c1bd84486eb",
"company_code": "sample string 12",
"db_address_id": "5950dc74-4437-49bb-983b-45d393672aea",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "2237a102-cf2b-4647-8503-18bf8cceb3d9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0d722b7c-eeba-45c7-a3d5-5ce45536ae80",
"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-25T01:29:01.3789988+00:00",
"date_create": "2026-05-25T01:29:01.3789988+00:00",
"date_update": "2026-05-25T01:29:01.3789988+00:00",
"updated_by_user_id": "f5ef45b3-d399-4f49-9e43-19f26b4a3206",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-25T01:29:01.3789988+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-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-25T01:29:01.3789988+00:00",
"date_last_job": "2026-05-25T01:29:01.3789988+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-25T01:29:01.3789988+00:00",
"modified_dateutc": "2026-05-25T01:29:01.3789988+00:00",
"is_mobile_installation": true
},
"job_type_id": "967fc274-e984-4fc6-88ba-f62127fad517",
"job_type_code": "sample string 7",
"job_type": {
"id": "07561401-d784-488d-9c77-041a4edc0199",
"name": "sample string 2",
"sales_organization_id": "476f9cd3-00d2-4140-a308-bac5a9af92b0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-25T01:29:01.3789988+00:00",
"code": "sample string 7"
},
"job_priority_id": "71dec5b3-8ef7-4b8a-a2c8-17dab11a6409",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7f0dc0c9-d6ed-45fe-8143-e49e7aa6c202",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a547d82e-216e-4ae6-b82e-5a3a4faea218",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a8d89c1e-1850-442d-84cb-acc91ed96ffc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a27afde-c7e5-4dad-b348-b1c58cf16b44",
"db_currency_id": "3064712d-c1a0-4bed-a620-b7894dbdfee6",
"db_language_id": "d2d756cd-7a4e-4049-90d3-2f6cb8e18e63",
"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-25T01:29:01.3633767+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-25T01:29:01.3789988+00:00"
},
"job_status_id": "12bb1c5f-fd43-480c-ac01-639ee17b96d0",
"job_status_code": "sample string 11",
"db_address_id": "0be944de-83f7-499a-8bcc-17bfd8786101",
"contact_id": "12079b2b-1a84-45a3-ba5d-d6fa8e31e6ce",
"requested_by_company_id": "0e0be448-2139-4bbf-952d-f3dcd1da0654",
"requested_by_contact_id": "3c1822e9-94c5-4703-b872-a67b96cf4001",
"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-25T01:29:01.3789988+00:00",
"due_date": "2026-05-25T01:29:01.3789988+00:00",
"date_create": "2026-05-25T01:29:01.3789988+00:00",
"date_update": "2026-05-25T01:29:01.3789988+00:00",
"date_closed": "2026-05-25T01:29:01.3789988+00:00",
"suggested_user_id": "c6cd8c46-f8d8-471f-b264-be17cdb89722",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "6b7e3fbb-8e88-40e6-8e95-41b393ed3955",
"db_language_id": "ed0b155b-6f37-4de4-8c96-83e6db769ab3",
"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-25T01:29:01.3789988+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "179cc636-2a86-4f87-8e67-cb388c61fadd",
"sales_organization": {
"id": "a8d89c1e-1850-442d-84cb-acc91ed96ffc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a27afde-c7e5-4dad-b348-b1c58cf16b44",
"db_currency_id": "3064712d-c1a0-4bed-a620-b7894dbdfee6",
"db_language_id": "d2d756cd-7a4e-4049-90d3-2f6cb8e18e63",
"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-25T01:29:01.3633767+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b51f6f6f-f032-4eeb-b363-c5fff260d3c2",
"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": "f09c5051-50ab-461b-998a-ff4fe29272c4",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-25T01:29:01.3789988+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "60fd4557-0f3b-4f63-8537-26963848720e"
},
"suggested_date_start": "2026-05-25T01:29:01.3789988+00:00",
"skill_id": "e283eab1-35d2-4e03-b86e-ba3207721577",
"skill_code": "sample string 32",
"skill": {
"id": "2d4285ee-dac0-411e-a1a4-24153f6a0ff4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "670d8a49-84a4-48b4-b9c9-91430545607e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a8d89c1e-1850-442d-84cb-acc91ed96ffc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5a27afde-c7e5-4dad-b348-b1c58cf16b44",
"db_currency_id": "3064712d-c1a0-4bed-a620-b7894dbdfee6",
"db_language_id": "d2d756cd-7a4e-4049-90d3-2f6cb8e18e63",
"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-25T01:29:01.3633767+00:00"
},
"modified_dateutc": "2026-05-25T01:29:01.3789988+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5372fc2b-4c32-4e14-abdd-6930715ab1d8",
"date_reported_by_company": "2026-05-25T01:29:01.3789988+00:00",
"id2": 36,
"company_id": "726a2c02-7b92-4acd-a21d-aaa3231bd8bf",
"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": "7d9b2ed4-078a-472c-9fa9-408856d4be81",
"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-25T01:29:01.3789988+00:00"
},
"work_instruction_details_id": "f04c978e-78ed-4cf3-a76a-0813ff78d4a8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "587a6e7e-e18a-4290-bc0a-4344128cc713",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "795fc557-6eab-48bc-88b2-d789608d3f6c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-25T01:29:01.3789988+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": "e8764516-1818-47a1-9ed2-41052867b044",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-25T01:29:01.3789988+00:00"
}