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": "48fed879-e62a-4966-8d4d-0a92f5bc8df3",
"jobs_id": "8a220f8c-1a60-47c5-b95c-dd5aef6bdc2e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b6bef025-90f0-49a6-b4e9-38b8f7f57c24",
"_parent_id": "484dc281-9676-4357-8257-44062ba67d8b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "df63ce70-6d10-448c-9ccb-3e4cbaad4543",
"project_reference_back_office": "sample string 5",
"project": {
"id": "26e8c57c-8eaa-43e6-8e60-7c9496be09d7",
"_parent_id": "85e118e0-0f0d-4347-8c58-a409373e5c8d",
"root_parent_id": "2cac355e-96e6-44a2-a735-8ea3e5f523cc",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "624c24a6-b70c-4a5d-890c-eb60ee5d8338",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "cebb5caf-c403-4293-bcad-1f9b10cc7d81",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9f958d51-8a4b-4b84-903a-a8d235736ffd",
"_parent_code": "sample string 6",
"sales_organization_id": "8c8e266d-f8f6-4213-b53e-e3b85aa07508",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c5c8070f-97ba-40b9-9d7e-0b2dd73e6db6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38742b48-7c54-46a5-9459-feb1adb018aa",
"db_currency_id": "412d1073-adc3-46b7-9822-38e5bd7b4f24",
"db_language_id": "9a6c865c-9211-409b-8b6f-3505da72aa4b",
"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-10-16T20:25:31.2759342+00:00"
},
"modified_dateutc": "2026-10-16T20:25:31.2759342+00:00"
},
"equipment_model_id": "ff985df6-7e53-4f93-8913-3ddb39163f55",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "bed7c8f5-6b6f-4898-a717-d02f78764ee0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "dbc29d09-6014-4934-8c42-d44804f68689",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "bdf989cf-f071-45e0-a49f-7264b66e5a51",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "5c1767a8-750a-4335-90f6-4f5862c8c580",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c5c8070f-97ba-40b9-9d7e-0b2dd73e6db6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38742b48-7c54-46a5-9459-feb1adb018aa",
"db_currency_id": "412d1073-adc3-46b7-9822-38e5bd7b4f24",
"db_language_id": "9a6c865c-9211-409b-8b6f-3505da72aa4b",
"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-10-16T20:25:31.2759342+00:00"
},
"modified_dateutc": "2026-10-16T20:25:31.2759342+00:00"
},
"equipment_family_id": "dbb759ed-b747-43d7-9796-28e755139c81",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "cebb5caf-c403-4293-bcad-1f9b10cc7d81",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9f958d51-8a4b-4b84-903a-a8d235736ffd",
"_parent_code": "sample string 6",
"sales_organization_id": "8c8e266d-f8f6-4213-b53e-e3b85aa07508",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c5c8070f-97ba-40b9-9d7e-0b2dd73e6db6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38742b48-7c54-46a5-9459-feb1adb018aa",
"db_currency_id": "412d1073-adc3-46b7-9822-38e5bd7b4f24",
"db_language_id": "9a6c865c-9211-409b-8b6f-3505da72aa4b",
"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-10-16T20:25:31.2759342+00:00"
},
"modified_dateutc": "2026-10-16T20:25:31.2759342+00:00"
},
"date_in_production_since": "2026-10-16T20:25:31.2759342+00:00",
"date_out_of_production_since": "2026-10-16T20:25:31.2759342+00:00",
"date_end_support": "2026-10-16T20:25:31.2759342+00:00",
"sales_organization_id": "5485bc8d-3dc5-460d-82dd-8bdec40b5207",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c5c8070f-97ba-40b9-9d7e-0b2dd73e6db6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38742b48-7c54-46a5-9459-feb1adb018aa",
"db_currency_id": "412d1073-adc3-46b7-9822-38e5bd7b4f24",
"db_language_id": "9a6c865c-9211-409b-8b6f-3505da72aa4b",
"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-10-16T20:25:31.2759342+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-10-16T20:25:31.2887062+00:00"
},
"project_status_id": "03471f0c-0976-41eb-b011-4b4af09ca32e",
"project_status_code": "sample string 10",
"project_status": {
"id": "e68a5546-65cd-4b41-8610-36fe4fe43d8a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "11b51829-9b5e-41ce-b992-19d30e57c06f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c5c8070f-97ba-40b9-9d7e-0b2dd73e6db6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38742b48-7c54-46a5-9459-feb1adb018aa",
"db_currency_id": "412d1073-adc3-46b7-9822-38e5bd7b4f24",
"db_language_id": "9a6c865c-9211-409b-8b6f-3505da72aa4b",
"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-10-16T20:25:31.2759342+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-16T20:25:31.2887062+00:00"
},
"company_id": "70b7b6a8-f59d-47c6-83e7-651e9acb91fc",
"company_code": "sample string 12",
"db_address_id": "fbdd0e11-26a3-40dc-9d00-d6991f9e4a48",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "25b863cb-0189-4deb-a92a-290287fe5e3f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "afb046b9-6738-40f9-b44c-a1a985fdc7f2",
"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-10-16T20:25:31.2887062+00:00",
"date_create": "2026-10-16T20:25:31.2887062+00:00",
"date_update": "2026-10-16T20:25:31.2887062+00:00",
"updated_by_user_id": "15e68017-1e92-4c2a-92bb-41672861d343",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-16T20:25:31.2887062+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-10-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-16T20:25:31.2887062+00:00",
"date_last_job": "2026-10-16T20:25:31.2887062+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-16T20:25:31.2887062+00:00",
"modified_dateutc": "2026-10-16T20:25:31.2887062+00:00",
"is_mobile_installation": true
},
"job_type_id": "58ac3d65-ddb4-4ddc-852e-4edcd3fc9995",
"job_type_code": "sample string 7",
"job_type": {
"id": "4b5d2b80-18a0-47fb-b424-1a8fdbbcb9d0",
"name": "sample string 2",
"sales_organization_id": "9c174cd6-a436-4e26-83f3-b44487e3570b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-16T20:25:31.2887062+00:00",
"code": "sample string 7"
},
"job_priority_id": "e0652804-5417-4548-843c-9b445d9791d6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "8f8a8a2e-a0d7-45a9-a8bb-b2586f37582e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9443c00b-55a1-4dcc-aa83-1280d126b32f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c5c8070f-97ba-40b9-9d7e-0b2dd73e6db6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38742b48-7c54-46a5-9459-feb1adb018aa",
"db_currency_id": "412d1073-adc3-46b7-9822-38e5bd7b4f24",
"db_language_id": "9a6c865c-9211-409b-8b6f-3505da72aa4b",
"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-10-16T20:25:31.2759342+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-16T20:25:31.2887062+00:00"
},
"job_status_id": "455fc6be-bde3-4aec-b975-073bc9bb5559",
"job_status_code": "sample string 11",
"db_address_id": "1fc2dfd2-713c-40ac-b9b4-fdef2e612631",
"contact_id": "55cfa810-9068-4886-95b1-c7c676034eef",
"requested_by_company_id": "66c2fe72-4268-42e0-8606-718a5135c6c3",
"requested_by_contact_id": "e8023afa-3747-4897-b0f8-9f9f78fd0a19",
"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-10-16T20:25:31.2887062+00:00",
"due_date": "2026-10-16T20:25:31.2887062+00:00",
"date_create": "2026-10-16T20:25:31.2887062+00:00",
"date_update": "2026-10-16T20:25:31.2887062+00:00",
"date_closed": "2026-10-16T20:25:31.2887062+00:00",
"suggested_user_id": "9bae7b52-5153-4706-b54f-cb31db36738f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "79f8edaa-4078-4c2a-abf1-cef008b15f1a",
"db_language_id": "031fd33e-9245-4a30-b31f-2a80b09f3199",
"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-10-16T20:25:31.3047345+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "68f183a2-7e8e-4d68-a91c-56ee6a594820",
"sales_organization": {
"id": "c5c8070f-97ba-40b9-9d7e-0b2dd73e6db6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38742b48-7c54-46a5-9459-feb1adb018aa",
"db_currency_id": "412d1073-adc3-46b7-9822-38e5bd7b4f24",
"db_language_id": "9a6c865c-9211-409b-8b6f-3505da72aa4b",
"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-10-16T20:25:31.2759342+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "35420324-2522-440b-8fb2-6444d888c513",
"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": "0d19e4fe-feb1-4ce8-82dd-50deede8ce34",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-16T20:25:31.3047345+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "be3a963b-afe9-4b11-85bf-58c1722b21d5"
},
"suggested_date_start": "2026-10-16T20:25:31.3047345+00:00",
"skill_id": "c620201b-4bd9-47a8-b9a3-853ebd62a651",
"skill_code": "sample string 32",
"skill": {
"id": "e9695845-6266-43d9-a5c5-7a550bb2308e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "0f198404-460f-45e2-90f3-a007a175d77e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c5c8070f-97ba-40b9-9d7e-0b2dd73e6db6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "38742b48-7c54-46a5-9459-feb1adb018aa",
"db_currency_id": "412d1073-adc3-46b7-9822-38e5bd7b4f24",
"db_language_id": "9a6c865c-9211-409b-8b6f-3505da72aa4b",
"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-10-16T20:25:31.2759342+00:00"
},
"modified_dateutc": "2026-10-16T20:25:31.3047345+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7dc06897-56e0-4619-a665-66838a924d55",
"date_reported_by_company": "2026-10-16T20:25:31.3047345+00:00",
"id2": 36,
"company_id": "39b620c3-4a2f-4ed1-b177-a866e3c64521",
"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": "3eee203e-8824-4ded-945c-0351bef68c27",
"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-10-16T20:25:31.3047345+00:00"
},
"work_instruction_details_id": "1c994b3f-ced6-4ae3-8e3e-a626146f631f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "668613b7-4d0d-4f20-8fa6-f7800b8c9cd3",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "68571282-c6f0-4319-993e-22e69552d4cf",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-16T20:25:31.3047345+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": "cae47c5b-f329-4c26-b903-e4d0f3529459",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-16T20:25:31.3047345+00:00"
}