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": "01c7db22-fc5a-4b45-b543-db7aeec373dc",
"jobs_id": "84b3c30c-17e0-466a-a3fc-34609088085d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c5df711d-edfb-40e3-ac1a-7c26d383bad5",
"_parent_id": "be142743-4fa3-43a2-bbcf-faee82af5b16",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e3da904f-319b-42de-ae69-82435f04bec3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8ac36995-5171-4350-a5a6-b375a0d3e3ad",
"_parent_id": "37e10872-8ecc-4d05-ad61-f13ad084ffad",
"root_parent_id": "5dbc38eb-0f7d-4979-8ab2-1c10c50b6114",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3112dda2-a1f6-4aa7-92a5-01b036de6dbb",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "36b6d5be-daad-4c06-b649-ee623de0b177",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "769dffa6-df5b-4608-b5e9-f77815ad1712",
"_parent_code": "sample string 6",
"sales_organization_id": "21d8abc1-ffd4-4dcf-8160-59d3e5c47a0b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0050a4ad-4142-4537-b3ff-e095e125f302",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "673e02dc-270a-4ddb-a9ff-37400850904e",
"db_currency_id": "5f5d3150-11e5-4129-bee7-c4e9551fa7c8",
"db_language_id": "f93fadb7-3206-4f45-9c63-3717b309ca60",
"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-01-29T11:49:13.459904+00:00"
},
"modified_dateutc": "2026-01-29T11:49:13.459904+00:00"
},
"equipment_model_id": "e70c1ded-9ae0-45b1-813b-504b901469ba",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "db90db57-570e-4b81-ad5e-0e27e7801985",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "94dbb013-f51d-4082-85cd-20c23ef41df3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "da8f451f-6001-41c8-8110-ab63cdab0d5e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7a86ade7-b3e6-4889-9b7f-8076064829bc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0050a4ad-4142-4537-b3ff-e095e125f302",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "673e02dc-270a-4ddb-a9ff-37400850904e",
"db_currency_id": "5f5d3150-11e5-4129-bee7-c4e9551fa7c8",
"db_language_id": "f93fadb7-3206-4f45-9c63-3717b309ca60",
"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-01-29T11:49:13.459904+00:00"
},
"modified_dateutc": "2026-01-29T11:49:13.459904+00:00"
},
"equipment_family_id": "2befb9e2-392f-4fc3-8823-26db2d4e32d4",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "36b6d5be-daad-4c06-b649-ee623de0b177",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "769dffa6-df5b-4608-b5e9-f77815ad1712",
"_parent_code": "sample string 6",
"sales_organization_id": "21d8abc1-ffd4-4dcf-8160-59d3e5c47a0b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0050a4ad-4142-4537-b3ff-e095e125f302",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "673e02dc-270a-4ddb-a9ff-37400850904e",
"db_currency_id": "5f5d3150-11e5-4129-bee7-c4e9551fa7c8",
"db_language_id": "f93fadb7-3206-4f45-9c63-3717b309ca60",
"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-01-29T11:49:13.459904+00:00"
},
"modified_dateutc": "2026-01-29T11:49:13.459904+00:00"
},
"date_in_production_since": "2026-01-29T11:49:13.459904+00:00",
"date_out_of_production_since": "2026-01-29T11:49:13.459904+00:00",
"date_end_support": "2026-01-29T11:49:13.459904+00:00",
"sales_organization_id": "8270d7d7-4bde-43e7-91c7-9cfac01f0a21",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0050a4ad-4142-4537-b3ff-e095e125f302",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "673e02dc-270a-4ddb-a9ff-37400850904e",
"db_currency_id": "5f5d3150-11e5-4129-bee7-c4e9551fa7c8",
"db_language_id": "f93fadb7-3206-4f45-9c63-3717b309ca60",
"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-01-29T11:49:13.459904+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-01-29T11:49:13.459904+00:00"
},
"project_status_id": "4e300ff0-f367-4eae-875a-8cd0e10af92e",
"project_status_code": "sample string 10",
"project_status": {
"id": "c6eb46ab-4b3a-4a0d-bb72-acb6da2b69c5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "83100232-c660-4f7d-a4fe-eaf12e6b71f0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0050a4ad-4142-4537-b3ff-e095e125f302",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "673e02dc-270a-4ddb-a9ff-37400850904e",
"db_currency_id": "5f5d3150-11e5-4129-bee7-c4e9551fa7c8",
"db_language_id": "f93fadb7-3206-4f45-9c63-3717b309ca60",
"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-01-29T11:49:13.459904+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-29T11:49:13.4755355+00:00"
},
"company_id": "792b271e-23bd-49f6-8d1f-8b071f758891",
"company_code": "sample string 12",
"db_address_id": "95a365a0-961c-4faf-8c02-a2e070aa15de",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1649d7be-0d46-48f5-9287-601ec286a477",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b02f6540-2a56-4a2c-b4ef-a008471040e3",
"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-01-29T11:49:13.4755355+00:00",
"date_create": "2026-01-29T11:49:13.4755355+00:00",
"date_update": "2026-01-29T11:49:13.4755355+00:00",
"updated_by_user_id": "e0eeddda-902e-4087-9856-e63f91022be9",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-29T11:49:13.4755355+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-01-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-29T11:49:13.4755355+00:00",
"date_last_job": "2026-01-29T11:49:13.4755355+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-29T11:49:13.4755355+00:00",
"modified_dateutc": "2026-01-29T11:49:13.4755355+00:00",
"is_mobile_installation": true
},
"job_type_id": "6f139092-c5e3-4bfc-a534-2721c7d7544d",
"job_type_code": "sample string 7",
"job_type": {
"id": "632af1d5-31b6-4b05-8dbb-195c88b03a24",
"name": "sample string 2",
"sales_organization_id": "e1f0ea94-bc3f-428a-9bd9-48b10fe440cb",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-29T11:49:13.4755355+00:00",
"code": "sample string 7"
},
"job_priority_id": "5d076101-7121-4dcc-b82b-51c3de6a8f87",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7ee3d9cb-4007-4570-b668-f8751fe0df32",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "cf2a6e4e-d783-4cd9-8be4-ed01102f2e94",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0050a4ad-4142-4537-b3ff-e095e125f302",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "673e02dc-270a-4ddb-a9ff-37400850904e",
"db_currency_id": "5f5d3150-11e5-4129-bee7-c4e9551fa7c8",
"db_language_id": "f93fadb7-3206-4f45-9c63-3717b309ca60",
"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-01-29T11:49:13.459904+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-29T11:49:13.4755355+00:00"
},
"job_status_id": "3432ac01-72ef-4864-aee1-ebda98cd1286",
"job_status_code": "sample string 11",
"db_address_id": "c8b77334-2f2e-485c-acb5-e8ecc4dbbcc8",
"contact_id": "698a00df-eff4-491b-822d-53e7d9d04e36",
"requested_by_company_id": "3fade682-665c-47c9-a954-b92428366594",
"requested_by_contact_id": "d1d04a6a-37d4-4671-a7b8-63261db81c18",
"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-01-29T11:49:13.4755355+00:00",
"due_date": "2026-01-29T11:49:13.4755355+00:00",
"date_create": "2026-01-29T11:49:13.4755355+00:00",
"date_update": "2026-01-29T11:49:13.4755355+00:00",
"date_closed": "2026-01-29T11:49:13.4755355+00:00",
"suggested_user_id": "306ef78b-059a-4a56-9d6f-0f72ad7d9a4e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3ce14773-f3cc-4bb2-b3f3-bd95938353c7",
"db_language_id": "5776b3a9-1f18-433f-8537-7adcc5cd4d01",
"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-01-29T11:49:13.4755355+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "cbcdaa09-6758-42b0-8569-fe4b393ac9c8",
"sales_organization": {
"id": "0050a4ad-4142-4537-b3ff-e095e125f302",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "673e02dc-270a-4ddb-a9ff-37400850904e",
"db_currency_id": "5f5d3150-11e5-4129-bee7-c4e9551fa7c8",
"db_language_id": "f93fadb7-3206-4f45-9c63-3717b309ca60",
"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-01-29T11:49:13.459904+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "11652b96-4e67-448c-93f2-64c9140fee06",
"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": "5eea0c15-a05f-45f9-b260-96e060ec7b49",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-29T11:49:13.4755355+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "96b5ab9f-d0c7-4cf7-86ed-3027097463ef"
},
"suggested_date_start": "2026-01-29T11:49:13.4755355+00:00",
"skill_id": "06138966-bee0-4131-9f10-5c86b0213d8c",
"skill_code": "sample string 32",
"skill": {
"id": "fdcf11d1-e969-4fb7-9371-97096fc079da",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "87fa9e91-e02f-47bc-92e1-67a55be9325b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0050a4ad-4142-4537-b3ff-e095e125f302",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "673e02dc-270a-4ddb-a9ff-37400850904e",
"db_currency_id": "5f5d3150-11e5-4129-bee7-c4e9551fa7c8",
"db_language_id": "f93fadb7-3206-4f45-9c63-3717b309ca60",
"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-01-29T11:49:13.459904+00:00"
},
"modified_dateutc": "2026-01-29T11:49:13.4755355+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c2e5a601-c557-4091-a1c8-3e881e2d32e1",
"date_reported_by_company": "2026-01-29T11:49:13.4755355+00:00",
"id2": 36,
"company_id": "27cb7d54-2f5e-4723-8c00-cf837276924d",
"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": "0f4269e7-f5c8-49cf-b8a2-ac51d1a22e82",
"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-01-29T11:49:13.4755355+00:00"
},
"work_instruction_details_id": "0eba6226-c1d4-460a-93f6-1c3c2b15ef3e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "06cf990a-1e56-4aa9-9da7-a3e2a51d6573",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9c437a98-c444-4e29-a27d-3118ae71488c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-29T11:49:13.4755355+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": "ed8b8933-75ef-4ef1-99fd-522c8ff870f6",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-29T11:49:13.4755355+00:00"
}