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": "8c82faa0-bc13-48f2-9c48-e3306593d2ac",
"jobs_id": "1581ac7e-7388-4f94-8127-721d07a0f9b7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fabcb3ba-9d6f-43f6-84a6-bcfd2dbd0ff3",
"_parent_id": "40a668b3-1a8e-4957-9cd1-814669b514b8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "926c83cb-cd2b-401b-accf-a76942cf554e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c2f60516-39f8-480e-8555-538a4e1b8b46",
"_parent_id": "8818c459-d578-463c-b465-010dab537212",
"root_parent_id": "cc97a36f-927b-4bec-9789-18d49b13ff74",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "387b97fa-21ce-4b55-be25-5d4797dded9c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a8da0920-f4eb-49c5-9fc0-8fa44f572237",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "26bfac61-0c48-42cd-886b-4b2a97d39542",
"_parent_code": "sample string 6",
"sales_organization_id": "97acc466-21ba-455e-88be-77376667fad4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a1a17d63-e57b-4534-b0ae-b550c08ce6ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7863ab01-913e-4470-890b-e2ceda727506",
"db_currency_id": "1e1254b5-d46b-4370-9e26-1869ff9491db",
"db_language_id": "df135fd6-a420-4124-840f-0701be770809",
"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": "2025-11-24T11:46:33.398437+00:00"
},
"modified_dateutc": "2025-11-24T11:46:33.398437+00:00"
},
"equipment_model_id": "df8889c4-1b41-4180-8fa5-8f3c559441c6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0f695e61-9fdf-4407-9577-1eb0503a12e3",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d1938fba-584a-4b0e-b5c5-a696797770c3",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "af15503f-ee58-48ee-9fb0-e5069da8b00e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a81389e8-9fb7-4d3e-8143-2686634be14f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a1a17d63-e57b-4534-b0ae-b550c08ce6ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7863ab01-913e-4470-890b-e2ceda727506",
"db_currency_id": "1e1254b5-d46b-4370-9e26-1869ff9491db",
"db_language_id": "df135fd6-a420-4124-840f-0701be770809",
"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": "2025-11-24T11:46:33.398437+00:00"
},
"modified_dateutc": "2025-11-24T11:46:33.398437+00:00"
},
"equipment_family_id": "adfdab83-e034-4554-8b31-d27208efef2f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a8da0920-f4eb-49c5-9fc0-8fa44f572237",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "26bfac61-0c48-42cd-886b-4b2a97d39542",
"_parent_code": "sample string 6",
"sales_organization_id": "97acc466-21ba-455e-88be-77376667fad4",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a1a17d63-e57b-4534-b0ae-b550c08ce6ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7863ab01-913e-4470-890b-e2ceda727506",
"db_currency_id": "1e1254b5-d46b-4370-9e26-1869ff9491db",
"db_language_id": "df135fd6-a420-4124-840f-0701be770809",
"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": "2025-11-24T11:46:33.398437+00:00"
},
"modified_dateutc": "2025-11-24T11:46:33.398437+00:00"
},
"date_in_production_since": "2025-11-24T11:46:33.398437+00:00",
"date_out_of_production_since": "2025-11-24T11:46:33.398437+00:00",
"date_end_support": "2025-11-24T11:46:33.398437+00:00",
"sales_organization_id": "a16e207a-1a03-41d5-8e67-e4fc4cee29a8",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a1a17d63-e57b-4534-b0ae-b550c08ce6ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7863ab01-913e-4470-890b-e2ceda727506",
"db_currency_id": "1e1254b5-d46b-4370-9e26-1869ff9491db",
"db_language_id": "df135fd6-a420-4124-840f-0701be770809",
"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": "2025-11-24T11:46:33.398437+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": "2025-11-24T11:46:33.398437+00:00"
},
"project_status_id": "b7250ff9-315b-4740-9348-f853c9846ff5",
"project_status_code": "sample string 10",
"project_status": {
"id": "fc52b597-23ca-45f7-ab05-61ae30e27997",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "699f00c6-c56d-4962-a951-1d21dedf6ac8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a1a17d63-e57b-4534-b0ae-b550c08ce6ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7863ab01-913e-4470-890b-e2ceda727506",
"db_currency_id": "1e1254b5-d46b-4370-9e26-1869ff9491db",
"db_language_id": "df135fd6-a420-4124-840f-0701be770809",
"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": "2025-11-24T11:46:33.398437+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-24T11:46:33.398437+00:00"
},
"company_id": "5fd42465-ab97-4e6b-b844-521b8ffccbd7",
"company_code": "sample string 12",
"db_address_id": "43bd8ea5-12c3-42fc-ad9a-03006f11a39d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8e973f26-129c-4841-9945-54ccf66bdfb1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "761cb70c-8bb9-4b6e-ba52-4e4648420f33",
"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": "2025-11-24T11:46:33.398437+00:00",
"date_create": "2025-11-24T11:46:33.398437+00:00",
"date_update": "2025-11-24T11:46:33.398437+00:00",
"updated_by_user_id": "20e0660c-3f93-401c-be90-978781cee591",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-24T11:46:33.398437+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": "2025-11-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-24T11:46:33.398437+00:00",
"date_last_job": "2025-11-24T11:46:33.398437+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-24T11:46:33.398437+00:00",
"modified_dateutc": "2025-11-24T11:46:33.398437+00:00",
"is_mobile_installation": true
},
"job_type_id": "6927ff13-2e93-4033-b3ee-220437b194b0",
"job_type_code": "sample string 7",
"job_type": {
"id": "f968cc5a-d8a6-4cf9-8702-e5559af81828",
"name": "sample string 2",
"sales_organization_id": "db34cc0d-0b3f-4a7c-a9b7-e21120764479",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-24T11:46:33.398437+00:00",
"code": "sample string 7"
},
"job_priority_id": "63938052-72a1-4d4f-88fb-809b2e2c1e21",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9701e564-cea5-49f5-9a9c-19200b737280",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b56fff17-9399-4a25-96bb-30067140ac0c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a1a17d63-e57b-4534-b0ae-b550c08ce6ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7863ab01-913e-4470-890b-e2ceda727506",
"db_currency_id": "1e1254b5-d46b-4370-9e26-1869ff9491db",
"db_language_id": "df135fd6-a420-4124-840f-0701be770809",
"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": "2025-11-24T11:46:33.398437+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-24T11:46:33.398437+00:00"
},
"job_status_id": "9326b5b5-17c0-4380-b9d2-035119682a76",
"job_status_code": "sample string 11",
"db_address_id": "3b18f8f8-8d7d-421d-8b1b-76eea1c385d3",
"contact_id": "cabdc2db-10bc-4184-9fb2-c3e133f05e1e",
"requested_by_company_id": "d056f5c9-80f1-4469-b640-e84b1e51d9bf",
"requested_by_contact_id": "03002e14-4f85-4029-b8b9-06aa5402a6c4",
"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": "2025-11-24T11:46:33.398437+00:00",
"due_date": "2025-11-24T11:46:33.398437+00:00",
"date_create": "2025-11-24T11:46:33.398437+00:00",
"date_update": "2025-11-24T11:46:33.398437+00:00",
"date_closed": "2025-11-24T11:46:33.398437+00:00",
"suggested_user_id": "6d92a911-3cac-4b08-8b30-9fef781d320f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7e5504ed-2c62-4057-a92f-6dfab47b2fb7",
"db_language_id": "5fd9d9f7-389e-4eb7-b3de-355a6d051bf9",
"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": "2025-11-24T11:46:33.398437+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ff85f797-99fd-4b93-ba11-2cffeabac65d",
"sales_organization": {
"id": "a1a17d63-e57b-4534-b0ae-b550c08ce6ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7863ab01-913e-4470-890b-e2ceda727506",
"db_currency_id": "1e1254b5-d46b-4370-9e26-1869ff9491db",
"db_language_id": "df135fd6-a420-4124-840f-0701be770809",
"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": "2025-11-24T11:46:33.398437+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "cf1565b1-51e4-4065-8dd1-8e9cf925c3c0",
"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": "f775f466-b414-4fe3-b72e-c0e40c548cdd",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-24T11:46:33.398437+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "1e109f01-6740-4668-b4d9-a137d3858030"
},
"suggested_date_start": "2025-11-24T11:46:33.398437+00:00",
"skill_id": "04fa0b84-0987-4e68-88d6-52a679ec5c3b",
"skill_code": "sample string 32",
"skill": {
"id": "3e3e9a4d-9945-4038-a2cf-09dd6e11c56d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "96fbe1fb-dbed-4bdb-a54b-d55de4399e34",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a1a17d63-e57b-4534-b0ae-b550c08ce6ed",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7863ab01-913e-4470-890b-e2ceda727506",
"db_currency_id": "1e1254b5-d46b-4370-9e26-1869ff9491db",
"db_language_id": "df135fd6-a420-4124-840f-0701be770809",
"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": "2025-11-24T11:46:33.398437+00:00"
},
"modified_dateutc": "2025-11-24T11:46:33.398437+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6fec46f3-5c9d-4e3b-913c-f40cadfdca8f",
"date_reported_by_company": "2025-11-24T11:46:33.398437+00:00",
"id2": 36,
"company_id": "08523a55-b499-4c7a-9db9-9ef9dec94e71",
"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": "a62d9c50-2021-4447-9e84-0a5fef7a3f58",
"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": "2025-11-24T11:46:33.398437+00:00"
},
"work_instruction_details_id": "89ec881d-960f-4525-9e6d-1ad1a2f3241e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7e7a4f00-1fe1-451e-b12e-4dcae921e087",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c33465eb-f419-48f3-8018-43bb6532ec11",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-24T11:46:33.398437+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": "7773e7a0-61c0-484f-beb0-cc70489ab233",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-24T11:46:33.398437+00:00"
}