Retrieves the job work instruction list with the specified key.
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
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": "1857bd31-382e-42f7-8e88-273a1fc762b4",
"jobs_id": "1211efbf-7652-4b83-82d4-c3cc402d363b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5a51423e-be1a-49d0-90a5-d24c4baa92d1",
"_parent_id": "b5d6d6d5-91e1-4e8c-bd40-33713c235162",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f5eb5ebb-e478-4edd-b4d2-915051a9e5ea",
"project_reference_back_office": "sample string 5",
"project": {
"id": "84590ec6-8d20-48dc-868d-f294d84715f2",
"_parent_id": "ef8cf6fc-6287-4cb7-b799-c2baee460e1e",
"root_parent_id": "b870997d-a6a9-4f3e-b4f4-d83f98dda308",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2f14309c-14f0-42c3-a116-d851a0b0d11b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "153f9883-86fb-4250-8a58-574ae4eda830",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2dce366a-858b-44b1-8672-725d9cf76841",
"_parent_code": "sample string 6",
"sales_organization_id": "1f971015-40a6-4f9f-86af-af8392a6b12f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "18c1265a-0bfb-4316-bd20-82963aa4970a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f2f0711-f3ba-4665-870b-6aea79001782",
"db_currency_id": "50eb0639-7c5a-4f12-8e66-c196ef5dca03",
"db_language_id": "b08b4dee-8f01-4e3f-bfc7-fff590b7ddd0",
"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-05-31T20:14:15.0702037+00:00"
},
"modified_dateutc": "2026-05-31T20:14:15.0702037+00:00"
},
"equipment_model_id": "142a129a-7c9e-46bb-9f3f-4b5707ea3b16",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b1cdbec1-55ca-40de-aa6f-8494215c2740",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5026ebb6-9a2a-4bef-8066-47f1579899dc",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ee0730b7-4a7a-4e69-a544-a2cb4635344b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a2732131-8ba7-48ec-8989-eaa73985f0f2",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "18c1265a-0bfb-4316-bd20-82963aa4970a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f2f0711-f3ba-4665-870b-6aea79001782",
"db_currency_id": "50eb0639-7c5a-4f12-8e66-c196ef5dca03",
"db_language_id": "b08b4dee-8f01-4e3f-bfc7-fff590b7ddd0",
"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-05-31T20:14:15.0702037+00:00"
},
"modified_dateutc": "2026-05-31T20:14:15.0702037+00:00"
},
"equipment_family_id": "4685c83c-a891-4a84-82f2-31243a3dec3d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "153f9883-86fb-4250-8a58-574ae4eda830",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "2dce366a-858b-44b1-8672-725d9cf76841",
"_parent_code": "sample string 6",
"sales_organization_id": "1f971015-40a6-4f9f-86af-af8392a6b12f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "18c1265a-0bfb-4316-bd20-82963aa4970a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f2f0711-f3ba-4665-870b-6aea79001782",
"db_currency_id": "50eb0639-7c5a-4f12-8e66-c196ef5dca03",
"db_language_id": "b08b4dee-8f01-4e3f-bfc7-fff590b7ddd0",
"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-05-31T20:14:15.0702037+00:00"
},
"modified_dateutc": "2026-05-31T20:14:15.0702037+00:00"
},
"date_in_production_since": "2026-05-31T20:14:15.0702037+00:00",
"date_out_of_production_since": "2026-05-31T20:14:15.0702037+00:00",
"date_end_support": "2026-05-31T20:14:15.0702037+00:00",
"sales_organization_id": "90236191-2874-44a9-b452-8ab5ec89033e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "18c1265a-0bfb-4316-bd20-82963aa4970a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f2f0711-f3ba-4665-870b-6aea79001782",
"db_currency_id": "50eb0639-7c5a-4f12-8e66-c196ef5dca03",
"db_language_id": "b08b4dee-8f01-4e3f-bfc7-fff590b7ddd0",
"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-05-31T20:14:15.0702037+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-05-31T20:14:15.0702037+00:00"
},
"project_status_id": "49468bcb-ed1b-48ae-ba81-d0708c1ae1be",
"project_status_code": "sample string 10",
"project_status": {
"id": "18e6cd16-bf9b-4f5a-a003-e949e718003d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7cbcd9a2-4cff-45ed-bab2-2e546744e51a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "18c1265a-0bfb-4316-bd20-82963aa4970a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f2f0711-f3ba-4665-870b-6aea79001782",
"db_currency_id": "50eb0639-7c5a-4f12-8e66-c196ef5dca03",
"db_language_id": "b08b4dee-8f01-4e3f-bfc7-fff590b7ddd0",
"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-05-31T20:14:15.0702037+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-31T20:14:15.0702037+00:00"
},
"company_id": "aee3a9b6-d118-4f28-a7bb-d18a7913ed10",
"company_code": "sample string 12",
"db_address_id": "5f2af310-145a-43d9-bebe-957c7e5dfb60",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0b648ad7-38b0-4c0c-a0fa-6ff9fe7212ca",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "deccda9f-7e5b-488d-84b7-92d7c188e9ee",
"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-05-31T20:14:15.0702037+00:00",
"date_create": "2026-05-31T20:14:15.0702037+00:00",
"date_update": "2026-05-31T20:14:15.0702037+00:00",
"updated_by_user_id": "819687f3-9bed-4723-9bf1-5333e90b35dc",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-31T20:14:15.0702037+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-05-31T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-31T20:14:15.0702037+00:00",
"date_last_job": "2026-05-31T20:14:15.0702037+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-31T20:14:15.0702037+00:00",
"modified_dateutc": "2026-05-31T20:14:15.0702037+00:00",
"is_mobile_installation": true
},
"job_type_id": "f0be73f7-a173-4402-8c62-2daae80f089d",
"job_type_code": "sample string 7",
"job_type": {
"id": "6e180edf-3771-4bbf-86d8-148946991444",
"name": "sample string 2",
"sales_organization_id": "fd025c2f-9fcc-4c2b-87de-af632a11ec48",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-31T20:14:15.0702037+00:00",
"code": "sample string 7"
},
"job_priority_id": "27076e70-5527-4994-bebb-172464c2e7d3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "db0ff725-e7c9-46a6-9106-35658fd410fe",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3005efdb-9e3f-475f-9e94-7504ea4ef3a1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "18c1265a-0bfb-4316-bd20-82963aa4970a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f2f0711-f3ba-4665-870b-6aea79001782",
"db_currency_id": "50eb0639-7c5a-4f12-8e66-c196ef5dca03",
"db_language_id": "b08b4dee-8f01-4e3f-bfc7-fff590b7ddd0",
"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-05-31T20:14:15.0702037+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-31T20:14:15.0702037+00:00"
},
"job_status_id": "e3c4b74d-e2aa-4e50-8b59-043f8ff8e5eb",
"job_status_code": "sample string 11",
"db_address_id": "aa0072f7-c8af-4a8d-85f0-5714abfb9001",
"contact_id": "9c500167-6124-4f1a-9dde-38a844f5438e",
"requested_by_company_id": "8489b568-9299-4bde-b9a8-92527856e93e",
"requested_by_contact_id": "7641e412-3c14-4db2-b996-266d8bb01ee3",
"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-05-31T20:14:15.0702037+00:00",
"due_date": "2026-05-31T20:14:15.0702037+00:00",
"date_create": "2026-05-31T20:14:15.0702037+00:00",
"date_update": "2026-05-31T20:14:15.0702037+00:00",
"date_closed": "2026-05-31T20:14:15.0702037+00:00",
"suggested_user_id": "69963c11-2ac0-4aee-abee-62028be22343",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cb13faed-82b6-4232-955e-31e86b465045",
"db_language_id": "2ceeead2-5d9a-40ea-87b8-2c292c2f61eb",
"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-05-31T20:14:15.0702037+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5aff36ef-9897-447f-90c3-d808fdb22e28",
"sales_organization": {
"id": "18c1265a-0bfb-4316-bd20-82963aa4970a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f2f0711-f3ba-4665-870b-6aea79001782",
"db_currency_id": "50eb0639-7c5a-4f12-8e66-c196ef5dca03",
"db_language_id": "b08b4dee-8f01-4e3f-bfc7-fff590b7ddd0",
"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-05-31T20:14:15.0702037+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "32a0486b-7491-4bea-b7b5-9d63b18482e4",
"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": "0f6ce141-9a82-4ede-9bdd-6ea5257a4a9c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-31T20:14:15.0858234+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ab255b60-912d-4f13-a565-9d28c4fc417d"
},
"suggested_date_start": "2026-05-31T20:14:15.0858234+00:00",
"skill_id": "d64d9b93-b730-445c-beb1-b143642b790a",
"skill_code": "sample string 32",
"skill": {
"id": "50cec3fb-52e9-49ac-8670-3795a1895d30",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9a7f81ce-2fca-49c2-a4a4-b4517f7b2ba0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "18c1265a-0bfb-4316-bd20-82963aa4970a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "3f2f0711-f3ba-4665-870b-6aea79001782",
"db_currency_id": "50eb0639-7c5a-4f12-8e66-c196ef5dca03",
"db_language_id": "b08b4dee-8f01-4e3f-bfc7-fff590b7ddd0",
"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-05-31T20:14:15.0702037+00:00"
},
"modified_dateutc": "2026-05-31T20:14:15.0858234+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3bb1a026-768f-430d-9c0c-825f6afa4b9e",
"date_reported_by_company": "2026-05-31T20:14:15.0858234+00:00",
"id2": 36,
"company_id": "b3203710-80f6-4fdb-802a-1a66339d4061",
"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": "b509832d-5057-4d39-948d-0f6581ed4e7b",
"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-05-31T20:14:15.0858234+00:00"
},
"work_instruction_details_id": "8d96d570-a638-4558-9e99-e19654706e46",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "45001775-2a09-4c93-b5a8-4069598f5748",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3d2e669e-bc47-4640-a9e5-be9ccb26fc75",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-31T20:14:15.0858234+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": "5135b8b6-85d0-4762-8bf2-1c3e40b6fe66",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-31T20:14:15.0858234+00:00"
}