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": "83ead1db-14c6-40f5-bf48-b6cebef0819e",
"jobs_id": "97ab64aa-1942-4873-af9b-6ccdb6ff2c5c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8fa12c9e-1d31-45d8-9473-c1d97b415f19",
"_parent_id": "595b2a2f-0e2e-49f3-a43f-069451cbbb12",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5a81583b-08db-4862-962a-d59362231bba",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e2daa294-9fdb-48c5-935e-0142690beff2",
"_parent_id": "296c3b0d-9500-462f-9e0d-088da58de2ab",
"root_parent_id": "f8f64a60-e1a7-4361-aad0-c811b2cc7ca9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ea97531f-a69f-4b1e-b1af-ddea4fe42c43",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "53562c5d-8466-4be5-b202-1c4a3163e829",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4efc6f84-44b0-4611-9895-aa58b5a49f7c",
"_parent_code": "sample string 6",
"sales_organization_id": "b79cf3c1-54d1-468f-baaa-6667741f9c23",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "02b045c4-ab1d-4721-80db-bd5819274fd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4002222-b3fb-4fea-b103-8d98d74658ce",
"db_currency_id": "1bb1a45e-4675-48a1-8206-7d2daebc5e8e",
"db_language_id": "24adff3d-835e-44c2-b796-82a4a3946ce2",
"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-02T02:43:48.4501278+00:00"
},
"modified_dateutc": "2026-01-02T02:43:48.4501278+00:00"
},
"equipment_model_id": "2f7c1f80-4351-4288-a94c-931e052e350c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0722a809-f927-4915-bd07-cd18c76bd376",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8614c5a1-b649-4777-9226-df75dd549566",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "118c5d1e-ce93-4793-9894-c1a0418c8dfa",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ec11bc90-db8a-4316-bc2f-dc8a652bd917",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "02b045c4-ab1d-4721-80db-bd5819274fd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4002222-b3fb-4fea-b103-8d98d74658ce",
"db_currency_id": "1bb1a45e-4675-48a1-8206-7d2daebc5e8e",
"db_language_id": "24adff3d-835e-44c2-b796-82a4a3946ce2",
"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-02T02:43:48.4501278+00:00"
},
"modified_dateutc": "2026-01-02T02:43:48.4501278+00:00"
},
"equipment_family_id": "dcce6782-28e9-4640-893c-a60ac9ba02dd",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "53562c5d-8466-4be5-b202-1c4a3163e829",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4efc6f84-44b0-4611-9895-aa58b5a49f7c",
"_parent_code": "sample string 6",
"sales_organization_id": "b79cf3c1-54d1-468f-baaa-6667741f9c23",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "02b045c4-ab1d-4721-80db-bd5819274fd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4002222-b3fb-4fea-b103-8d98d74658ce",
"db_currency_id": "1bb1a45e-4675-48a1-8206-7d2daebc5e8e",
"db_language_id": "24adff3d-835e-44c2-b796-82a4a3946ce2",
"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-02T02:43:48.4501278+00:00"
},
"modified_dateutc": "2026-01-02T02:43:48.4501278+00:00"
},
"date_in_production_since": "2026-01-02T02:43:48.4501278+00:00",
"date_out_of_production_since": "2026-01-02T02:43:48.4501278+00:00",
"date_end_support": "2026-01-02T02:43:48.4501278+00:00",
"sales_organization_id": "513e1b3c-7bd9-447e-933b-019e41459a9e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "02b045c4-ab1d-4721-80db-bd5819274fd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4002222-b3fb-4fea-b103-8d98d74658ce",
"db_currency_id": "1bb1a45e-4675-48a1-8206-7d2daebc5e8e",
"db_language_id": "24adff3d-835e-44c2-b796-82a4a3946ce2",
"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-02T02:43:48.4501278+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-02T02:43:48.4501278+00:00"
},
"project_status_id": "5e65f48d-1df7-46ce-855a-aca8e368a76f",
"project_status_code": "sample string 10",
"project_status": {
"id": "e05f7f1e-4c98-45c8-baf8-da3cf32666ee",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ddfbb34b-fe04-44bc-a77d-68643db052fd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "02b045c4-ab1d-4721-80db-bd5819274fd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4002222-b3fb-4fea-b103-8d98d74658ce",
"db_currency_id": "1bb1a45e-4675-48a1-8206-7d2daebc5e8e",
"db_language_id": "24adff3d-835e-44c2-b796-82a4a3946ce2",
"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-02T02:43:48.4501278+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-02T02:43:48.4641624+00:00"
},
"company_id": "25fc8b49-cb01-4754-98ff-ae1c58731ed6",
"company_code": "sample string 12",
"db_address_id": "5d2da59b-5ee9-4358-bf2e-1013f03d499a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1da7ba68-b3ee-476b-a95b-f82494c94cae",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2c50cd64-749b-4eb6-86f2-73b038844551",
"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-02T02:43:48.4641624+00:00",
"date_create": "2026-01-02T02:43:48.4641624+00:00",
"date_update": "2026-01-02T02:43:48.4641624+00:00",
"updated_by_user_id": "9f4be367-62bd-4c8d-9aae-0ba6f0ae02cc",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-02T02:43:48.4641624+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-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-02T02:43:48.4641624+00:00",
"date_last_job": "2026-01-02T02:43:48.4641624+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-02T02:43:48.4641624+00:00",
"modified_dateutc": "2026-01-02T02:43:48.4641624+00:00",
"is_mobile_installation": true
},
"job_type_id": "e3c17a8f-17ea-4c78-9a7d-b2e05b73722a",
"job_type_code": "sample string 7",
"job_type": {
"id": "3936df90-3a58-496a-910e-543c94ca4157",
"name": "sample string 2",
"sales_organization_id": "6aaf6086-ab8d-4319-9838-cff79ccf84fe",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-02T02:43:48.4641624+00:00",
"code": "sample string 7"
},
"job_priority_id": "cf758f31-27ae-49d7-a031-600d16bf06e7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "aac9aa3a-ef6a-42a1-b7e1-08f441c05eee",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "98d743f6-1305-4d8a-9849-2f3513eb4332",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "02b045c4-ab1d-4721-80db-bd5819274fd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4002222-b3fb-4fea-b103-8d98d74658ce",
"db_currency_id": "1bb1a45e-4675-48a1-8206-7d2daebc5e8e",
"db_language_id": "24adff3d-835e-44c2-b796-82a4a3946ce2",
"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-02T02:43:48.4501278+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-02T02:43:48.4641624+00:00"
},
"job_status_id": "ed7b321c-c656-404a-bf1e-9310e68bf711",
"job_status_code": "sample string 11",
"db_address_id": "4f623219-5f82-4798-b683-a3dd38ca0cd7",
"contact_id": "a913cd61-f102-426d-9479-af7e31763e57",
"requested_by_company_id": "7e88576c-408b-4fd0-8b8d-883b3f2bafbf",
"requested_by_contact_id": "d6809cb1-42c1-4f5e-acc1-7431662d9454",
"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-02T02:43:48.4641624+00:00",
"due_date": "2026-01-02T02:43:48.4641624+00:00",
"date_create": "2026-01-02T02:43:48.4641624+00:00",
"date_update": "2026-01-02T02:43:48.4641624+00:00",
"date_closed": "2026-01-02T02:43:48.4641624+00:00",
"suggested_user_id": "82e7cefc-25cb-4c35-a62f-eccf960aa619",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d18d71aa-7b73-4ca5-b438-fdfbfd2cb658",
"db_language_id": "32ff5947-bd27-46fe-9f54-11752f07e39a",
"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-02T02:43:48.4641624+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "fb1ff2d3-f9de-4691-aea3-c23fed64782f",
"sales_organization": {
"id": "02b045c4-ab1d-4721-80db-bd5819274fd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4002222-b3fb-4fea-b103-8d98d74658ce",
"db_currency_id": "1bb1a45e-4675-48a1-8206-7d2daebc5e8e",
"db_language_id": "24adff3d-835e-44c2-b796-82a4a3946ce2",
"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-02T02:43:48.4501278+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3e1b972d-bb89-4c1a-b14a-670f185e9543",
"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": "384ba449-78bf-4cd4-96fe-46258cac94ca",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-02T02:43:48.4641624+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1830607a-357c-4f1c-ba6c-dd1a8e1e35f6"
},
"suggested_date_start": "2026-01-02T02:43:48.4641624+00:00",
"skill_id": "bfb1fb0b-42f9-451f-a6cf-35d7177e37c9",
"skill_code": "sample string 32",
"skill": {
"id": "fe732701-928e-414a-9a92-88683cef78be",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4b7afd81-735a-4e7f-91f8-8010728f0c3a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "02b045c4-ab1d-4721-80db-bd5819274fd5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e4002222-b3fb-4fea-b103-8d98d74658ce",
"db_currency_id": "1bb1a45e-4675-48a1-8206-7d2daebc5e8e",
"db_language_id": "24adff3d-835e-44c2-b796-82a4a3946ce2",
"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-02T02:43:48.4501278+00:00"
},
"modified_dateutc": "2026-01-02T02:43:48.4641624+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9d1109f7-3587-4b88-9d91-dfc911102066",
"date_reported_by_company": "2026-01-02T02:43:48.4641624+00:00",
"id2": 36,
"company_id": "b65da25c-0c78-4917-8e3d-6ec63cb2fbfb",
"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": "027af1ca-ae98-4131-9dc9-018d335f12e2",
"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-02T02:43:48.4641624+00:00"
},
"work_instruction_details_id": "47689c41-38ee-4d36-ae41-768354bdab6f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a5acd9b0-cc2a-4c59-87c9-64997851983a",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f7127a2a-548c-4121-a7c8-c25e93a68dee",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-02T02:43:48.4641624+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": "35d725e3-89fb-45e6-a51b-1099211a7bb1",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-02T02:43:48.4641624+00:00"
}