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": "681f6017-b157-4558-86ed-26887883946d",
"jobs_id": "d90475b6-4026-4faa-a6f5-43103084a161",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "076c5af4-abea-4a95-ae9f-e76066ff7be0",
"_parent_id": "b325a430-004b-43a7-9555-ff85160e488b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8e60ec89-7edb-49a8-8670-f54c9bea5a62",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1002e7d9-67cf-4938-9499-275c98ddae6f",
"_parent_id": "80a16d3a-553c-400f-895d-ca5743740f48",
"root_parent_id": "a8a82879-d7ea-409d-b930-fc2b90446aaf",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "473a6c09-426a-4779-8d60-ca63759a6f4a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "56f661c0-42da-4181-ae30-1cfa5fb10d1a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "66fcf4d5-a3c2-47a6-8e96-710a00c661c7",
"_parent_code": "sample string 6",
"sales_organization_id": "adb98a03-1e17-42e8-b62c-7293e69426ae",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "58d7bd72-388d-4f86-8a04-d76dcc742145",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c2cb769-1254-4ca7-ac86-853572df19b7",
"db_currency_id": "3756717c-c6f6-4e4b-9f42-57b44667481d",
"db_language_id": "fa35059a-b29f-416b-99e2-6f0ecf718408",
"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-23T19:49:23.1825649+00:00"
},
"modified_dateutc": "2026-01-23T19:49:23.1825649+00:00"
},
"equipment_model_id": "9f63cf1f-ddae-4c8b-a75e-0e23bd2dc97e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3f6efd33-6417-4d04-af1d-ae6f4224dbf1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a374b472-5a44-4505-ba39-e8246a34c5d0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3c391dd9-e4a4-401b-b941-42a50a222f02",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "67e270f2-1eca-4ece-8aa2-0750d45dcd23",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "58d7bd72-388d-4f86-8a04-d76dcc742145",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c2cb769-1254-4ca7-ac86-853572df19b7",
"db_currency_id": "3756717c-c6f6-4e4b-9f42-57b44667481d",
"db_language_id": "fa35059a-b29f-416b-99e2-6f0ecf718408",
"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-23T19:49:23.1825649+00:00"
},
"modified_dateutc": "2026-01-23T19:49:23.1825649+00:00"
},
"equipment_family_id": "c3706c04-2216-4cff-9d22-af8a73c46fbf",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "56f661c0-42da-4181-ae30-1cfa5fb10d1a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "66fcf4d5-a3c2-47a6-8e96-710a00c661c7",
"_parent_code": "sample string 6",
"sales_organization_id": "adb98a03-1e17-42e8-b62c-7293e69426ae",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "58d7bd72-388d-4f86-8a04-d76dcc742145",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c2cb769-1254-4ca7-ac86-853572df19b7",
"db_currency_id": "3756717c-c6f6-4e4b-9f42-57b44667481d",
"db_language_id": "fa35059a-b29f-416b-99e2-6f0ecf718408",
"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-23T19:49:23.1825649+00:00"
},
"modified_dateutc": "2026-01-23T19:49:23.1825649+00:00"
},
"date_in_production_since": "2026-01-23T19:49:23.1825649+00:00",
"date_out_of_production_since": "2026-01-23T19:49:23.1825649+00:00",
"date_end_support": "2026-01-23T19:49:23.1825649+00:00",
"sales_organization_id": "3b19c502-0468-4560-bf9b-508fdcb7d388",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "58d7bd72-388d-4f86-8a04-d76dcc742145",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c2cb769-1254-4ca7-ac86-853572df19b7",
"db_currency_id": "3756717c-c6f6-4e4b-9f42-57b44667481d",
"db_language_id": "fa35059a-b29f-416b-99e2-6f0ecf718408",
"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-23T19:49:23.1825649+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-23T19:49:23.1825649+00:00"
},
"project_status_id": "aa992ae4-fe67-4ecf-b0e9-69ea078e68bf",
"project_status_code": "sample string 10",
"project_status": {
"id": "49fc05fe-64bb-4318-a41b-c0f25bb56a1f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "ea167963-24c1-4d3a-a8f9-4031d9b426e3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "58d7bd72-388d-4f86-8a04-d76dcc742145",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c2cb769-1254-4ca7-ac86-853572df19b7",
"db_currency_id": "3756717c-c6f6-4e4b-9f42-57b44667481d",
"db_language_id": "fa35059a-b29f-416b-99e2-6f0ecf718408",
"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-23T19:49:23.1825649+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-23T19:49:23.1825649+00:00"
},
"company_id": "415fa5aa-583d-4d64-9900-a33a7db176cb",
"company_code": "sample string 12",
"db_address_id": "1cc1d942-642b-4abb-a341-9f9722f4eb44",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9216f4b1-f72c-456b-a11b-30d2cac5cd88",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bd473f56-04f5-4cba-a272-aec49ccd4825",
"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-23T19:49:23.1825649+00:00",
"date_create": "2026-01-23T19:49:23.1825649+00:00",
"date_update": "2026-01-23T19:49:23.1825649+00:00",
"updated_by_user_id": "44daa314-0a1f-45ec-97a7-1a2c6052c5ea",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-23T19:49:23.1825649+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-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-23T19:49:23.1825649+00:00",
"date_last_job": "2026-01-23T19:49:23.1825649+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-23T19:49:23.1825649+00:00",
"modified_dateutc": "2026-01-23T19:49:23.1825649+00:00",
"is_mobile_installation": true
},
"job_type_id": "caabdaf0-e92f-4fbd-bb8f-ce0a15035841",
"job_type_code": "sample string 7",
"job_type": {
"id": "f737d45c-a4e1-44d5-ac72-035165bffe78",
"name": "sample string 2",
"sales_organization_id": "9f802632-295b-4eca-9a66-23af53f36162",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-23T19:49:23.1825649+00:00",
"code": "sample string 7"
},
"job_priority_id": "38f602e1-bdad-4f53-8475-00e1cfbd4589",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9f9fb787-2dc4-4167-bec1-e9e610997c85",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "652daa50-803d-4a51-b99d-c51b496f69c4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "58d7bd72-388d-4f86-8a04-d76dcc742145",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c2cb769-1254-4ca7-ac86-853572df19b7",
"db_currency_id": "3756717c-c6f6-4e4b-9f42-57b44667481d",
"db_language_id": "fa35059a-b29f-416b-99e2-6f0ecf718408",
"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-23T19:49:23.1825649+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-23T19:49:23.1825649+00:00"
},
"job_status_id": "e6fd5a5a-012f-4655-830f-02236cdc7d50",
"job_status_code": "sample string 11",
"db_address_id": "2a905d77-0852-436a-ad9c-bed0d6b4b0c2",
"contact_id": "0fa9b680-e33d-47b7-b995-223a19e67e26",
"requested_by_company_id": "7ff6bc10-b330-453b-b457-539d62c8206f",
"requested_by_contact_id": "bee64d1f-b990-4844-84c2-23ffe97c8049",
"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-23T19:49:23.1825649+00:00",
"due_date": "2026-01-23T19:49:23.1825649+00:00",
"date_create": "2026-01-23T19:49:23.1825649+00:00",
"date_update": "2026-01-23T19:49:23.1825649+00:00",
"date_closed": "2026-01-23T19:49:23.1825649+00:00",
"suggested_user_id": "7ecec05e-b1e2-417d-97e4-775f73dc62cf",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fa639b02-10d5-457a-a54a-27064cdd1712",
"db_language_id": "69bb5ea3-7d47-4ee9-9fd9-b235caa189d5",
"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-23T19:49:23.1825649+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "7d3ff289-2ad2-4efe-bb86-46d57e6e6657",
"sales_organization": {
"id": "58d7bd72-388d-4f86-8a04-d76dcc742145",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c2cb769-1254-4ca7-ac86-853572df19b7",
"db_currency_id": "3756717c-c6f6-4e4b-9f42-57b44667481d",
"db_language_id": "fa35059a-b29f-416b-99e2-6f0ecf718408",
"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-23T19:49:23.1825649+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "371ea22d-af98-439e-8b3f-265d05c7d21a",
"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": "781ee406-d676-41ac-b53b-f575cb348928",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-23T19:49:23.1825649+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "88fcd4ad-e87b-4158-a6a0-0626ff36b60a"
},
"suggested_date_start": "2026-01-23T19:49:23.1825649+00:00",
"skill_id": "48f10340-1b90-4e3d-843d-b01c7ffbe48f",
"skill_code": "sample string 32",
"skill": {
"id": "4280625e-c71b-49d9-a24a-f1f311536b12",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "be0588dd-4474-44a1-8d6e-2015cfc7544b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "58d7bd72-388d-4f86-8a04-d76dcc742145",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5c2cb769-1254-4ca7-ac86-853572df19b7",
"db_currency_id": "3756717c-c6f6-4e4b-9f42-57b44667481d",
"db_language_id": "fa35059a-b29f-416b-99e2-6f0ecf718408",
"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-23T19:49:23.1825649+00:00"
},
"modified_dateutc": "2026-01-23T19:49:23.1825649+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c415668e-e953-47f8-be3d-909eebba0b67",
"date_reported_by_company": "2026-01-23T19:49:23.1825649+00:00",
"id2": 36,
"company_id": "2132f1d8-fdb1-452d-b5a0-280f5936de94",
"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": "e8a85177-eb22-4332-b515-3b06c61ed5e8",
"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-23T19:49:23.1825649+00:00"
},
"work_instruction_details_id": "baf5180d-1221-403b-b08a-f1fe71c65066",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a36f85c1-af5c-4f3a-9242-6d5bbd7c3d70",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4fd2419d-af34-4346-998a-fa0b4771b22a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-23T19:49:23.1981896+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": "a26dd411-641c-44bd-8684-395c2ac91d5e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-23T19:49:23.1981896+00:00"
}