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": "bb0b5876-e563-45d6-bcf2-ccbf9cf06ad5",
"jobs_id": "d6ef95a1-d216-44dc-8083-9e8005b5c574",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c262c762-3b0a-4b41-bcd5-a5d278ccac85",
"_parent_id": "621d70ef-076d-42b1-8bac-604700885ed7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "42b93532-2598-43b3-874b-d08460f70691",
"project_reference_back_office": "sample string 5",
"project": {
"id": "00d238cf-3fcb-4586-b1dc-86802b777e8c",
"_parent_id": "74c6f820-cbcb-4fda-9b25-cccfd4829174",
"root_parent_id": "c7ffab15-02a6-4b2c-84fe-eda70c976cb6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "681135d7-5393-4e00-8209-640e5c63768b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b0b6a4b0-d1b1-4623-94c1-c7f4eed639b5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "72444851-2f20-41cb-bb3d-781886b955d2",
"_parent_code": "sample string 6",
"sales_organization_id": "5682e026-0e59-4df0-a19c-0019c371def8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1d6124b8-f1f0-46d2-bda6-f5240e9bcef1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c3c4920-c61f-4868-95db-3cbca1127c2e",
"db_currency_id": "f385945a-a871-47aa-be92-34f0ca77fede",
"db_language_id": "f6e5a814-6346-404d-ac0a-76c7778bb9db",
"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-08-05T12:45:58.2179239+00:00"
},
"modified_dateutc": "2026-08-05T12:45:58.2179239+00:00"
},
"equipment_model_id": "b8fdd5b6-bbb9-4efc-85ed-661b3a41389e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3c60a980-51cd-4ced-9157-380d0eeba5d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "c2665d74-71c4-4b3a-b51e-4b8c4d70c225",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "e9c213e2-3ca4-44cb-b246-fc3dfa7bff32",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "aa106782-1d48-417e-8de5-0785d8057b13",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1d6124b8-f1f0-46d2-bda6-f5240e9bcef1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c3c4920-c61f-4868-95db-3cbca1127c2e",
"db_currency_id": "f385945a-a871-47aa-be92-34f0ca77fede",
"db_language_id": "f6e5a814-6346-404d-ac0a-76c7778bb9db",
"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-08-05T12:45:58.2179239+00:00"
},
"modified_dateutc": "2026-08-05T12:45:58.2179239+00:00"
},
"equipment_family_id": "2e16b94f-6e9d-4456-9fe9-c9e4bbbd66e8",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b0b6a4b0-d1b1-4623-94c1-c7f4eed639b5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "72444851-2f20-41cb-bb3d-781886b955d2",
"_parent_code": "sample string 6",
"sales_organization_id": "5682e026-0e59-4df0-a19c-0019c371def8",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1d6124b8-f1f0-46d2-bda6-f5240e9bcef1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c3c4920-c61f-4868-95db-3cbca1127c2e",
"db_currency_id": "f385945a-a871-47aa-be92-34f0ca77fede",
"db_language_id": "f6e5a814-6346-404d-ac0a-76c7778bb9db",
"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-08-05T12:45:58.2179239+00:00"
},
"modified_dateutc": "2026-08-05T12:45:58.2179239+00:00"
},
"date_in_production_since": "2026-08-05T12:45:58.2179239+00:00",
"date_out_of_production_since": "2026-08-05T12:45:58.2179239+00:00",
"date_end_support": "2026-08-05T12:45:58.2179239+00:00",
"sales_organization_id": "79aadcdb-2e05-401b-a28d-ac1ab2e02b07",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1d6124b8-f1f0-46d2-bda6-f5240e9bcef1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c3c4920-c61f-4868-95db-3cbca1127c2e",
"db_currency_id": "f385945a-a871-47aa-be92-34f0ca77fede",
"db_language_id": "f6e5a814-6346-404d-ac0a-76c7778bb9db",
"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-08-05T12:45:58.2179239+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-08-05T12:45:58.2179239+00:00"
},
"project_status_id": "41041d34-2e27-405d-b7f1-664601aeec1e",
"project_status_code": "sample string 10",
"project_status": {
"id": "f1316965-f06f-4a5b-958e-72a6cb8315a4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "39ecbfc7-baf1-4f7f-9490-d9b44c2d1fd6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1d6124b8-f1f0-46d2-bda6-f5240e9bcef1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c3c4920-c61f-4868-95db-3cbca1127c2e",
"db_currency_id": "f385945a-a871-47aa-be92-34f0ca77fede",
"db_language_id": "f6e5a814-6346-404d-ac0a-76c7778bb9db",
"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-08-05T12:45:58.2179239+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-05T12:45:58.2179239+00:00"
},
"company_id": "40d8a7f5-d61a-4d12-9cb5-b18a252801b5",
"company_code": "sample string 12",
"db_address_id": "03136834-63f7-4f3c-af04-d7afbdc4b748",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "87b3af2d-791f-4a10-aac4-e35dc22dcbaf",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cdc1bec8-3532-4d9f-ab6a-2f7325b4e35e",
"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-08-05T12:45:58.2179239+00:00",
"date_create": "2026-08-05T12:45:58.2179239+00:00",
"date_update": "2026-08-05T12:45:58.2179239+00:00",
"updated_by_user_id": "0a12b552-b3a7-443a-bc77-de56e251554b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-05T12:45:58.2179239+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-08-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-05T12:45:58.2179239+00:00",
"date_last_job": "2026-08-05T12:45:58.2179239+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-05T12:45:58.2179239+00:00",
"modified_dateutc": "2026-08-05T12:45:58.2179239+00:00",
"is_mobile_installation": true
},
"job_type_id": "7e5e39a5-7723-4c03-82af-520912ed04c8",
"job_type_code": "sample string 7",
"job_type": {
"id": "55ad9e38-436e-4bc6-b1a4-e972c21ca723",
"name": "sample string 2",
"sales_organization_id": "81f9cbbe-523c-4b3a-8443-57230c0d7abf",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-05T12:45:58.2179239+00:00",
"code": "sample string 7"
},
"job_priority_id": "79c0a57b-814d-4cd3-bec1-9223e314dae1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "45ba20bd-8430-4397-b32c-a481721a4dba",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8443f598-a63d-4496-8544-91a7b60d9975",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1d6124b8-f1f0-46d2-bda6-f5240e9bcef1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c3c4920-c61f-4868-95db-3cbca1127c2e",
"db_currency_id": "f385945a-a871-47aa-be92-34f0ca77fede",
"db_language_id": "f6e5a814-6346-404d-ac0a-76c7778bb9db",
"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-08-05T12:45:58.2179239+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-05T12:45:58.2179239+00:00"
},
"job_status_id": "89c64fff-249b-420c-ba96-7eb0b6a1892e",
"job_status_code": "sample string 11",
"db_address_id": "fcede34d-7147-4c9a-8715-cb4d1afd2efd",
"contact_id": "26365260-eb30-4daa-9777-90c161243c18",
"requested_by_company_id": "201c2822-4aa5-499e-adf1-7c93b1630d33",
"requested_by_contact_id": "99db479d-b108-4310-9e37-ef868c897808",
"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-08-05T12:45:58.2179239+00:00",
"due_date": "2026-08-05T12:45:58.2179239+00:00",
"date_create": "2026-08-05T12:45:58.2179239+00:00",
"date_update": "2026-08-05T12:45:58.2179239+00:00",
"date_closed": "2026-08-05T12:45:58.2179239+00:00",
"suggested_user_id": "b9e782a3-cc0e-4b36-847d-aa52d114e5c9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ea6d736e-52c7-47b9-aad7-c659aeedcc92",
"db_language_id": "25ef8333-4668-44a8-a91b-36bc8e472324",
"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-08-05T12:45:58.2179239+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "40e0f928-9052-4c3b-9041-7e4079ed8d33",
"sales_organization": {
"id": "1d6124b8-f1f0-46d2-bda6-f5240e9bcef1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c3c4920-c61f-4868-95db-3cbca1127c2e",
"db_currency_id": "f385945a-a871-47aa-be92-34f0ca77fede",
"db_language_id": "f6e5a814-6346-404d-ac0a-76c7778bb9db",
"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-08-05T12:45:58.2179239+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6926de30-bc78-43d6-a351-e3befd049b2c",
"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": "1fc3a671-4f18-4c56-9b98-c826dc15d1ea",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-05T12:45:58.2179239+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "01af024f-cfbe-4215-b8dc-9a5cd497ea90"
},
"suggested_date_start": "2026-08-05T12:45:58.2179239+00:00",
"skill_id": "12e775e5-1e7e-4088-a9db-c3c127a8f8c7",
"skill_code": "sample string 32",
"skill": {
"id": "db50c024-3bdd-4a56-a08b-ede9098e9ec6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "faffac0a-eec1-45b5-90d0-4942080085e6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1d6124b8-f1f0-46d2-bda6-f5240e9bcef1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c3c4920-c61f-4868-95db-3cbca1127c2e",
"db_currency_id": "f385945a-a871-47aa-be92-34f0ca77fede",
"db_language_id": "f6e5a814-6346-404d-ac0a-76c7778bb9db",
"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-08-05T12:45:58.2179239+00:00"
},
"modified_dateutc": "2026-08-05T12:45:58.2179239+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1858eb66-d87c-422d-8cf3-a280e0c5e6fe",
"date_reported_by_company": "2026-08-05T12:45:58.2179239+00:00",
"id2": 36,
"company_id": "57ae17bd-ffa0-4f5a-9a46-c7c69d9ce22f",
"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": "262ad84e-ee48-4c81-8689-ec3cecb714e9",
"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-08-05T12:45:58.2179239+00:00"
},
"work_instruction_details_id": "d00b76e5-95f8-47f1-b1eb-c8da3ad4c689",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "bf617e3c-db34-423c-8fb2-33ffe7429d39",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3e5c5b3e-4e71-4508-90a4-9e04bd69cb26",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-05T12:45:58.2179239+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": "d0d999e4-f0e9-4551-a2b6-0842e9b1adf4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-05T12:45:58.2179239+00:00"
}