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": "27cdeab8-a224-426d-ba61-3cf71f9631e9",
"jobs_id": "6ab0d121-00e8-4282-8301-d4e6a1f60efe",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a2e1a57c-4b3b-4367-824c-861a602fa8b7",
"_parent_id": "20b2e061-92e7-4c71-9de3-dca8f345c963",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cc22b440-5626-427a-a75b-4a84b35da091",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3d9be2f4-de30-4b0d-a789-25e3ae550bee",
"_parent_id": "a10afb13-9ab5-4162-a3cd-f260d57e1c78",
"root_parent_id": "b7bb97f7-87fc-4064-84c3-f486574ccbe1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e239bb13-71ff-45a8-9f96-e40ddd3ca27b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b700e560-ab5f-4e9a-b97f-05b498f8e946",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "be18d59d-cbcb-4aba-8ab0-43cf6a1f2c91",
"_parent_code": "sample string 6",
"sales_organization_id": "bc05c8e0-7a28-4465-8da1-93af038c68b9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fa674380-01ff-4f13-b00a-0f1b6b199595",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7426a999-dfc1-435d-867b-e73b1f13f496",
"db_currency_id": "97ee8363-bd7d-47a3-ac84-18f898d9d771",
"db_language_id": "31fb0409-e1fd-441d-a6f1-a49778f3297d",
"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-03-12T06:10:13.6492271+00:00"
},
"modified_dateutc": "2026-03-12T06:10:13.6492271+00:00"
},
"equipment_model_id": "d1ae1980-3353-42c0-a807-437ca76f8df9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a52b8b51-4ea2-4414-98ca-c2e694f16971",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0cfd96af-b86a-4a2d-8948-123ad68a216b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "bca36a36-5219-4be2-9846-5c800084849f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "762fefe8-50a0-4a6a-8ec2-8d86d9d8e4f8",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fa674380-01ff-4f13-b00a-0f1b6b199595",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7426a999-dfc1-435d-867b-e73b1f13f496",
"db_currency_id": "97ee8363-bd7d-47a3-ac84-18f898d9d771",
"db_language_id": "31fb0409-e1fd-441d-a6f1-a49778f3297d",
"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-03-12T06:10:13.6492271+00:00"
},
"modified_dateutc": "2026-03-12T06:10:13.6492271+00:00"
},
"equipment_family_id": "f2406444-1fa7-4ff7-aecc-7da6a2012ce5",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b700e560-ab5f-4e9a-b97f-05b498f8e946",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "be18d59d-cbcb-4aba-8ab0-43cf6a1f2c91",
"_parent_code": "sample string 6",
"sales_organization_id": "bc05c8e0-7a28-4465-8da1-93af038c68b9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fa674380-01ff-4f13-b00a-0f1b6b199595",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7426a999-dfc1-435d-867b-e73b1f13f496",
"db_currency_id": "97ee8363-bd7d-47a3-ac84-18f898d9d771",
"db_language_id": "31fb0409-e1fd-441d-a6f1-a49778f3297d",
"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-03-12T06:10:13.6492271+00:00"
},
"modified_dateutc": "2026-03-12T06:10:13.6492271+00:00"
},
"date_in_production_since": "2026-03-12T06:10:13.6492271+00:00",
"date_out_of_production_since": "2026-03-12T06:10:13.6492271+00:00",
"date_end_support": "2026-03-12T06:10:13.6492271+00:00",
"sales_organization_id": "d0fc5ffe-1846-4588-854b-efd02901963c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fa674380-01ff-4f13-b00a-0f1b6b199595",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7426a999-dfc1-435d-867b-e73b1f13f496",
"db_currency_id": "97ee8363-bd7d-47a3-ac84-18f898d9d771",
"db_language_id": "31fb0409-e1fd-441d-a6f1-a49778f3297d",
"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-03-12T06:10:13.6492271+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-03-12T06:10:13.6492271+00:00"
},
"project_status_id": "b74e74ce-0d37-470b-9bba-2a76662e7dd2",
"project_status_code": "sample string 10",
"project_status": {
"id": "4b171877-7f93-4e83-bbdd-81b396dc7af5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7db06e01-541e-4f77-8f6d-eba1f3834547",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fa674380-01ff-4f13-b00a-0f1b6b199595",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7426a999-dfc1-435d-867b-e73b1f13f496",
"db_currency_id": "97ee8363-bd7d-47a3-ac84-18f898d9d771",
"db_language_id": "31fb0409-e1fd-441d-a6f1-a49778f3297d",
"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-03-12T06:10:13.6492271+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-12T06:10:13.6492271+00:00"
},
"company_id": "765a20f8-931f-498a-96d1-d7173b79f564",
"company_code": "sample string 12",
"db_address_id": "f08b2627-6712-41f6-aff6-ef57e81b8d46",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c32409e8-12e6-4621-a8de-7ed493684749",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ab32e4e3-64d3-48a6-86e2-fe99f11a90a7",
"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-03-12T06:10:13.6492271+00:00",
"date_create": "2026-03-12T06:10:13.6492271+00:00",
"date_update": "2026-03-12T06:10:13.6492271+00:00",
"updated_by_user_id": "e2101415-4c91-4028-8f78-a44bdc505893",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-12T06:10:13.6492271+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-03-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-12T06:10:13.6492271+00:00",
"date_last_job": "2026-03-12T06:10:13.6492271+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-12T06:10:13.6492271+00:00",
"modified_dateutc": "2026-03-12T06:10:13.6492271+00:00",
"is_mobile_installation": true
},
"job_type_id": "dcba2ccf-0f6b-4631-9fd8-7bad6535dbcc",
"job_type_code": "sample string 7",
"job_type": {
"id": "4857a303-d6dd-4965-9164-f95cc41517ac",
"name": "sample string 2",
"sales_organization_id": "765d1a74-b01b-4e87-818b-5a3834c1a38f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-12T06:10:13.6492271+00:00",
"code": "sample string 7"
},
"job_priority_id": "20c99f08-8c5f-4483-80df-9a23ef3d034c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "b907c391-c2e6-4dec-8032-94edbe9378d7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "813b8ed6-3d10-4e0c-894e-5e727121e505",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fa674380-01ff-4f13-b00a-0f1b6b199595",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7426a999-dfc1-435d-867b-e73b1f13f496",
"db_currency_id": "97ee8363-bd7d-47a3-ac84-18f898d9d771",
"db_language_id": "31fb0409-e1fd-441d-a6f1-a49778f3297d",
"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-03-12T06:10:13.6492271+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-12T06:10:13.6492271+00:00"
},
"job_status_id": "e9823ac5-d80b-4aca-9de7-811ab0553000",
"job_status_code": "sample string 11",
"db_address_id": "a38f32d3-9ea9-48a8-b0d1-9d22d2efea16",
"contact_id": "501cdc85-d902-4d7e-888d-4f69c326ce6c",
"requested_by_company_id": "1392d232-cf98-4ec2-9e73-ce6d007b2627",
"requested_by_contact_id": "0c9fd838-9f61-496c-8336-c236ec214427",
"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-03-12T06:10:13.6492271+00:00",
"due_date": "2026-03-12T06:10:13.6492271+00:00",
"date_create": "2026-03-12T06:10:13.6492271+00:00",
"date_update": "2026-03-12T06:10:13.6492271+00:00",
"date_closed": "2026-03-12T06:10:13.6492271+00:00",
"suggested_user_id": "6946917a-a095-415e-897c-cd259acb707c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ab5395f6-8f40-4070-abbd-f67e91300991",
"db_language_id": "b9221411-8324-41ee-8782-b97cdd531d48",
"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-03-12T06:10:13.6492271+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "bae9698a-6f9a-4141-af5f-98da1e508e1f",
"sales_organization": {
"id": "fa674380-01ff-4f13-b00a-0f1b6b199595",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7426a999-dfc1-435d-867b-e73b1f13f496",
"db_currency_id": "97ee8363-bd7d-47a3-ac84-18f898d9d771",
"db_language_id": "31fb0409-e1fd-441d-a6f1-a49778f3297d",
"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-03-12T06:10:13.6492271+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "a72cd42e-36c8-40ff-85ee-eba1641374bd",
"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": "6ef428d2-2534-4c98-b217-c04b059e9064",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-12T06:10:13.6492271+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "227b838a-625e-47e1-93db-66371500de72"
},
"suggested_date_start": "2026-03-12T06:10:13.6492271+00:00",
"skill_id": "c4b04693-07c6-4f13-8ffa-174bf5272359",
"skill_code": "sample string 32",
"skill": {
"id": "bb20a151-974b-4a06-9bbc-4e57afcfad9e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4b769f13-4ca8-45a7-8861-77270ff6eee4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fa674380-01ff-4f13-b00a-0f1b6b199595",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7426a999-dfc1-435d-867b-e73b1f13f496",
"db_currency_id": "97ee8363-bd7d-47a3-ac84-18f898d9d771",
"db_language_id": "31fb0409-e1fd-441d-a6f1-a49778f3297d",
"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-03-12T06:10:13.6492271+00:00"
},
"modified_dateutc": "2026-03-12T06:10:13.6492271+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4974bc68-1b5b-43af-afc9-6f46a9aab0f5",
"date_reported_by_company": "2026-03-12T06:10:13.6492271+00:00",
"id2": 36,
"company_id": "b208470b-c52d-4e5f-ae0b-f5d53bedd399",
"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": "828fc9a6-f8ca-4cab-8f6f-687e2eee0a93",
"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-03-12T06:10:13.6648565+00:00"
},
"work_instruction_details_id": "ed6d9f7a-7edb-4ef8-896a-7a9f73cf8f6c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "eada6330-8fa2-417d-bcf2-1ef6620047ac",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "49277a6a-7c68-47e5-b1cd-0a0a0c118c5c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-12T06:10:13.6648565+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": "5a0bb880-3bc7-479e-a195-475b58bddd8e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-12T06:10:13.6648565+00:00"
}