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": "c0479ac2-8cf4-4761-a10a-c80e46173a8d",
"jobs_id": "bd1fe7f9-07e9-474a-bdad-8318ff2ace12",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8c73a064-fbb0-48e5-88c6-974c1398ad13",
"_parent_id": "1739f4ef-6e58-448d-a666-a2fcf8a0079b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2e34bf22-b1fe-49e1-b378-2bf5a87e5f7a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a3819d7b-b0d2-41c0-9ec4-49d09e96d71a",
"_parent_id": "ec756e11-b0a7-4d24-9618-cb9e0f9a2ddd",
"root_parent_id": "429bbc39-81eb-4975-8d6a-6c7e69165520",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e42f10be-c697-46d9-8942-d5d9f373a725",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3480c0f7-29ff-42e4-bc2a-6998e60ed2eb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ceeff1af-5167-478d-acdb-f32eb1c99e92",
"_parent_code": "sample string 6",
"sales_organization_id": "f8fa4e70-ddbd-4aa4-90c3-8aaed515e24b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f4250271-29e2-46c4-b331-64f701a1f8c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "601741f9-1dcd-4ed6-a862-b1186f7bff38",
"db_currency_id": "5d5a2462-eb5d-4900-b58f-b814dbb923fe",
"db_language_id": "c6a9760f-1d59-4467-9665-657bcf8bf970",
"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-09-29T00:15:44.6457192+00:00"
},
"modified_dateutc": "2026-09-29T00:15:44.6457192+00:00"
},
"equipment_model_id": "455f7a80-05be-4e5a-9591-8ac935e654f9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "cce695a1-0497-42e7-94c7-27f07d4abb01",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ca4a4224-5e71-414c-a656-07948db141de",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7a323e38-6a26-47aa-8823-1e490bffb680",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "1f5c9779-11e2-4fdc-88ec-6138bfe17464",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f4250271-29e2-46c4-b331-64f701a1f8c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "601741f9-1dcd-4ed6-a862-b1186f7bff38",
"db_currency_id": "5d5a2462-eb5d-4900-b58f-b814dbb923fe",
"db_language_id": "c6a9760f-1d59-4467-9665-657bcf8bf970",
"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-09-29T00:15:44.6457192+00:00"
},
"modified_dateutc": "2026-09-29T00:15:44.6457192+00:00"
},
"equipment_family_id": "daa7b0e6-13c4-4b2e-9065-b78c4e66c226",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3480c0f7-29ff-42e4-bc2a-6998e60ed2eb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ceeff1af-5167-478d-acdb-f32eb1c99e92",
"_parent_code": "sample string 6",
"sales_organization_id": "f8fa4e70-ddbd-4aa4-90c3-8aaed515e24b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f4250271-29e2-46c4-b331-64f701a1f8c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "601741f9-1dcd-4ed6-a862-b1186f7bff38",
"db_currency_id": "5d5a2462-eb5d-4900-b58f-b814dbb923fe",
"db_language_id": "c6a9760f-1d59-4467-9665-657bcf8bf970",
"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-09-29T00:15:44.6457192+00:00"
},
"modified_dateutc": "2026-09-29T00:15:44.6457192+00:00"
},
"date_in_production_since": "2026-09-29T00:15:44.6457192+00:00",
"date_out_of_production_since": "2026-09-29T00:15:44.6457192+00:00",
"date_end_support": "2026-09-29T00:15:44.6457192+00:00",
"sales_organization_id": "cf381135-1485-41f5-9b99-5b07d0714d14",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f4250271-29e2-46c4-b331-64f701a1f8c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "601741f9-1dcd-4ed6-a862-b1186f7bff38",
"db_currency_id": "5d5a2462-eb5d-4900-b58f-b814dbb923fe",
"db_language_id": "c6a9760f-1d59-4467-9665-657bcf8bf970",
"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-09-29T00:15:44.6457192+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-09-29T00:15:44.6457192+00:00"
},
"project_status_id": "d8d66d09-9506-4a02-8492-cf3c96590e99",
"project_status_code": "sample string 10",
"project_status": {
"id": "8a90f6e5-8486-4a85-afe8-d79cf3797611",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f8e1cc9b-6443-4062-977c-730cc9915ceb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f4250271-29e2-46c4-b331-64f701a1f8c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "601741f9-1dcd-4ed6-a862-b1186f7bff38",
"db_currency_id": "5d5a2462-eb5d-4900-b58f-b814dbb923fe",
"db_language_id": "c6a9760f-1d59-4467-9665-657bcf8bf970",
"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-09-29T00:15:44.6457192+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-29T00:15:44.6457192+00:00"
},
"company_id": "8deb80ee-ec4e-4a18-b3c2-8280941c4c56",
"company_code": "sample string 12",
"db_address_id": "c9911227-8d68-48ef-bcfb-03d589ab7964",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1e5f4131-1882-444c-9488-9b2406256570",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "94214f27-02bc-44c6-bdf0-6520bd9143d9",
"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-09-29T00:15:44.6457192+00:00",
"date_create": "2026-09-29T00:15:44.6457192+00:00",
"date_update": "2026-09-29T00:15:44.6457192+00:00",
"updated_by_user_id": "52bc999a-9849-4cd0-acf3-f0a21dd78e6f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-29T00:15:44.6457192+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-09-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-29T00:15:44.6457192+00:00",
"date_last_job": "2026-09-29T00:15:44.6457192+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-29T00:15:44.6457192+00:00",
"modified_dateutc": "2026-09-29T00:15:44.6457192+00:00",
"is_mobile_installation": true
},
"job_type_id": "e6728ae0-459d-4f95-af89-5462d9408f7c",
"job_type_code": "sample string 7",
"job_type": {
"id": "97b47cdc-a88e-450f-82e7-bdf94b8682a2",
"name": "sample string 2",
"sales_organization_id": "02534a1e-1246-44c4-80e5-5423733faa44",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-29T00:15:44.6457192+00:00",
"code": "sample string 7"
},
"job_priority_id": "fb66431d-19c5-4548-8663-66f6a4ebc1ab",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "abeeab90-e4f0-4c95-8f6f-6e89a13c2b95",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "655a23a4-1dc4-4cf0-9ff4-a33357e464b1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f4250271-29e2-46c4-b331-64f701a1f8c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "601741f9-1dcd-4ed6-a862-b1186f7bff38",
"db_currency_id": "5d5a2462-eb5d-4900-b58f-b814dbb923fe",
"db_language_id": "c6a9760f-1d59-4467-9665-657bcf8bf970",
"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-09-29T00:15:44.6457192+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-29T00:15:44.6457192+00:00"
},
"job_status_id": "45349436-3ae9-4b94-854a-7a1f32c60aa3",
"job_status_code": "sample string 11",
"db_address_id": "dcc2767e-7fc6-4c04-9e9e-bbf6eda36b1c",
"contact_id": "923e2712-bb18-48f1-9223-3720eaa5a169",
"requested_by_company_id": "99b7d848-97c7-4fe7-bb30-2286dc0c846b",
"requested_by_contact_id": "0c4e9267-f084-4b06-ac2f-24a0f87b873d",
"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-09-29T00:15:44.6457192+00:00",
"due_date": "2026-09-29T00:15:44.6457192+00:00",
"date_create": "2026-09-29T00:15:44.6457192+00:00",
"date_update": "2026-09-29T00:15:44.6457192+00:00",
"date_closed": "2026-09-29T00:15:44.6457192+00:00",
"suggested_user_id": "a3dfbac8-074c-4224-b2ab-3aa514f5029a",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "247198d3-e857-4548-be54-95ca962cfd99",
"db_language_id": "98d9acfe-c5ba-4cab-a6f8-89408316ed92",
"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-09-29T00:15:44.6457192+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "84f55156-ac61-4267-af20-67e94d2fb93f",
"sales_organization": {
"id": "f4250271-29e2-46c4-b331-64f701a1f8c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "601741f9-1dcd-4ed6-a862-b1186f7bff38",
"db_currency_id": "5d5a2462-eb5d-4900-b58f-b814dbb923fe",
"db_language_id": "c6a9760f-1d59-4467-9665-657bcf8bf970",
"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-09-29T00:15:44.6457192+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "35e0464e-ffef-4980-8ad9-4eaefc19d37d",
"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": "dcd0a605-77fd-4ec1-a9a2-4b2ee3eb0d84",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-29T00:15:44.6457192+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d84f54ff-a85a-4f1f-9b54-c366bd80ed65"
},
"suggested_date_start": "2026-09-29T00:15:44.6457192+00:00",
"skill_id": "c2193cf0-66f0-4482-83da-0bdf52c27ada",
"skill_code": "sample string 32",
"skill": {
"id": "659138ef-07b0-4470-81c1-5ebf10b7283c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "47bce879-18fd-45f1-aab4-7f6484134120",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f4250271-29e2-46c4-b331-64f701a1f8c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "601741f9-1dcd-4ed6-a862-b1186f7bff38",
"db_currency_id": "5d5a2462-eb5d-4900-b58f-b814dbb923fe",
"db_language_id": "c6a9760f-1d59-4467-9665-657bcf8bf970",
"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-09-29T00:15:44.6457192+00:00"
},
"modified_dateutc": "2026-09-29T00:15:44.6457192+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "032fbd62-6d95-4ca7-97ff-11d3b3c2d607",
"date_reported_by_company": "2026-09-29T00:15:44.6457192+00:00",
"id2": 36,
"company_id": "0fce9dcc-4da3-482f-87b8-113b59cdf3ab",
"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": "f1496307-18c0-4bfe-a3a1-43402bdd78c2",
"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-09-29T00:15:44.6457192+00:00"
},
"work_instruction_details_id": "ef03d660-3878-494e-a105-63276cca123f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2e380d8d-22bb-4be2-8b77-79c7c73c9992",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0c83afd9-dd69-4398-8ea2-ecbb76628e8e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-29T00:15:44.6457192+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": "f677acf8-4a0e-4f04-b7fe-ec9f3b79adb3",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-29T00:15:44.6457192+00:00"
}