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": "e5358f9b-6470-4d15-8a70-1ab46b0a36d1",
"jobs_id": "8e954c19-a3c0-4ab7-aa94-40d400925761",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c3ac6af8-78c4-47b3-acf6-f8d116e82c16",
"_parent_id": "bab032a7-4e08-4ed0-ba62-fcb6a7685f73",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c47ac17b-6454-4471-8e59-58893fdd43d4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "325cec88-2e6b-499d-8409-bafaf15e3a16",
"_parent_id": "ec43e1a9-1497-4df6-b987-b3408903d504",
"root_parent_id": "9b7ad0ad-ee3c-4bb6-a4cd-52934b7bae8b",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2aedbc64-62c6-4c52-8b0f-115aa6ca03de",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5c242a44-6e97-4c59-9b3b-a621c160dbe7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ff220590-4605-4a59-93ef-a62f91026b23",
"_parent_code": "sample string 6",
"sales_organization_id": "1d4d003e-9315-4548-9a8b-36bd239f9601",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8c09f12b-b70d-4434-8780-0fc3d00a45d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed369edb-ce2c-42e3-a03c-a2ccda4c8a49",
"db_currency_id": "652f426d-beaf-4eb0-887c-c5ca5e1fdd0b",
"db_language_id": "ac83ab4c-f930-45b3-80f0-f8c28a3146e3",
"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-02-25T13:26:01.0669739+00:00"
},
"modified_dateutc": "2026-02-25T13:26:01.0669739+00:00"
},
"equipment_model_id": "df2645e4-c703-4e31-b60a-07b34408efbd",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b650d1be-6ad3-42ab-a022-768571a659ee",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e2cab7eb-3038-4ea4-a3ce-0d3ddb8ab437",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "96126146-970b-4c90-8229-ba4683998c8c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e68da34d-a85d-4cde-89ed-f3821b159493",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8c09f12b-b70d-4434-8780-0fc3d00a45d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed369edb-ce2c-42e3-a03c-a2ccda4c8a49",
"db_currency_id": "652f426d-beaf-4eb0-887c-c5ca5e1fdd0b",
"db_language_id": "ac83ab4c-f930-45b3-80f0-f8c28a3146e3",
"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-02-25T13:26:01.0669739+00:00"
},
"modified_dateutc": "2026-02-25T13:26:01.0669739+00:00"
},
"equipment_family_id": "6325a079-e92a-4024-ab00-9c60c4334d98",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5c242a44-6e97-4c59-9b3b-a621c160dbe7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ff220590-4605-4a59-93ef-a62f91026b23",
"_parent_code": "sample string 6",
"sales_organization_id": "1d4d003e-9315-4548-9a8b-36bd239f9601",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8c09f12b-b70d-4434-8780-0fc3d00a45d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed369edb-ce2c-42e3-a03c-a2ccda4c8a49",
"db_currency_id": "652f426d-beaf-4eb0-887c-c5ca5e1fdd0b",
"db_language_id": "ac83ab4c-f930-45b3-80f0-f8c28a3146e3",
"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-02-25T13:26:01.0669739+00:00"
},
"modified_dateutc": "2026-02-25T13:26:01.0669739+00:00"
},
"date_in_production_since": "2026-02-25T13:26:01.0669739+00:00",
"date_out_of_production_since": "2026-02-25T13:26:01.0669739+00:00",
"date_end_support": "2026-02-25T13:26:01.0669739+00:00",
"sales_organization_id": "a57d367b-9d05-482d-83ca-fde9461058ac",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8c09f12b-b70d-4434-8780-0fc3d00a45d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed369edb-ce2c-42e3-a03c-a2ccda4c8a49",
"db_currency_id": "652f426d-beaf-4eb0-887c-c5ca5e1fdd0b",
"db_language_id": "ac83ab4c-f930-45b3-80f0-f8c28a3146e3",
"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-02-25T13:26:01.0669739+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-02-25T13:26:01.0669739+00:00"
},
"project_status_id": "de0f2be7-b548-45d1-99d4-61d18013db20",
"project_status_code": "sample string 10",
"project_status": {
"id": "296b3f54-97c1-482f-add4-f570214614e0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "2a352c28-2472-417c-83d1-0fd0a48fab7c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8c09f12b-b70d-4434-8780-0fc3d00a45d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed369edb-ce2c-42e3-a03c-a2ccda4c8a49",
"db_currency_id": "652f426d-beaf-4eb0-887c-c5ca5e1fdd0b",
"db_language_id": "ac83ab4c-f930-45b3-80f0-f8c28a3146e3",
"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-02-25T13:26:01.0669739+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-25T13:26:01.0669739+00:00"
},
"company_id": "f48daaf3-fccb-4652-a6c7-e423400be194",
"company_code": "sample string 12",
"db_address_id": "b85c5757-9ad9-4bd5-8cdb-ddc8062be381",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0af14ed8-e6b5-4706-bddd-7be3d75f3240",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "1c452e8c-23f8-4d14-8550-026b18945849",
"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-02-25T13:26:01.0669739+00:00",
"date_create": "2026-02-25T13:26:01.0669739+00:00",
"date_update": "2026-02-25T13:26:01.0669739+00:00",
"updated_by_user_id": "6556971a-8cfd-460b-b602-db823d678af4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-25T13:26:01.0669739+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-02-25T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-25T13:26:01.0669739+00:00",
"date_last_job": "2026-02-25T13:26:01.0669739+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-25T13:26:01.0669739+00:00",
"modified_dateutc": "2026-02-25T13:26:01.0669739+00:00",
"is_mobile_installation": true
},
"job_type_id": "7355c00c-faa6-4b2e-a131-d599e1965e8f",
"job_type_code": "sample string 7",
"job_type": {
"id": "ceec5f34-1615-405e-a068-e2b7d575b9c6",
"name": "sample string 2",
"sales_organization_id": "64ec32a9-28fd-42be-bcb8-2c287391d465",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-25T13:26:01.0669739+00:00",
"code": "sample string 7"
},
"job_priority_id": "f8ec0ea0-c256-43aa-a527-495629af6498",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1815522f-4bab-46b6-b756-c797faac2463",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a2b2dc1c-409e-4619-81d4-3e6cc859ee4d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8c09f12b-b70d-4434-8780-0fc3d00a45d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed369edb-ce2c-42e3-a03c-a2ccda4c8a49",
"db_currency_id": "652f426d-beaf-4eb0-887c-c5ca5e1fdd0b",
"db_language_id": "ac83ab4c-f930-45b3-80f0-f8c28a3146e3",
"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-02-25T13:26:01.0669739+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-25T13:26:01.0669739+00:00"
},
"job_status_id": "e5bd6ae5-982d-43c5-8fdb-879d730df7d1",
"job_status_code": "sample string 11",
"db_address_id": "71739605-b2b1-4d5c-921b-f672bbada6a5",
"contact_id": "d4df8aad-8213-4f68-bbc7-0eb45e2d3519",
"requested_by_company_id": "dc2d9c0d-adb6-42e7-b63f-11568f620d53",
"requested_by_contact_id": "68078f7e-a59b-4bff-ad93-a6f63a36fea2",
"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-02-25T13:26:01.0669739+00:00",
"due_date": "2026-02-25T13:26:01.0669739+00:00",
"date_create": "2026-02-25T13:26:01.0669739+00:00",
"date_update": "2026-02-25T13:26:01.0669739+00:00",
"date_closed": "2026-02-25T13:26:01.0669739+00:00",
"suggested_user_id": "c00de953-b212-4ced-b58e-1ce5aa90ae29",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "abe16166-6508-44dc-b9e1-9dee5b376414",
"db_language_id": "c78c4380-e936-4a7e-807b-d04c6e813fd2",
"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-02-25T13:26:01.0669739+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1ff6820e-44a2-4c9f-8925-73266c3e68e4",
"sales_organization": {
"id": "8c09f12b-b70d-4434-8780-0fc3d00a45d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed369edb-ce2c-42e3-a03c-a2ccda4c8a49",
"db_currency_id": "652f426d-beaf-4eb0-887c-c5ca5e1fdd0b",
"db_language_id": "ac83ab4c-f930-45b3-80f0-f8c28a3146e3",
"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-02-25T13:26:01.0669739+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "39633f87-68d3-46eb-9f83-aef65d2cbf6b",
"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": "71764cdf-c49f-4dee-88b0-5a56ea7ef6ae",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-25T13:26:01.0669739+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0c4b982f-2a37-4276-80b4-1e432169003b"
},
"suggested_date_start": "2026-02-25T13:26:01.0669739+00:00",
"skill_id": "283db266-4ed8-43a4-830b-9dd676632bd4",
"skill_code": "sample string 32",
"skill": {
"id": "9f635749-c417-4c72-9790-4a6afc142c03",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "057ae89c-6a1b-4c6d-ac85-ba178fd45b51",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8c09f12b-b70d-4434-8780-0fc3d00a45d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ed369edb-ce2c-42e3-a03c-a2ccda4c8a49",
"db_currency_id": "652f426d-beaf-4eb0-887c-c5ca5e1fdd0b",
"db_language_id": "ac83ab4c-f930-45b3-80f0-f8c28a3146e3",
"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-02-25T13:26:01.0669739+00:00"
},
"modified_dateutc": "2026-02-25T13:26:01.0669739+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "69f31383-7a8f-49eb-ae81-f8f6af2a5c34",
"date_reported_by_company": "2026-02-25T13:26:01.0669739+00:00",
"id2": 36,
"company_id": "5a94fdc4-87fe-48e2-ba6c-5e325abe8f4d",
"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": "ed505d82-92d4-4f57-ba4f-7c92c5a2978d",
"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-02-25T13:26:01.0669739+00:00"
},
"work_instruction_details_id": "dbf32e8b-fc4a-4e03-9d1d-596cde6a58a5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cc88cb7c-c87f-47c6-a5f6-6ff974d7fe84",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9f5d272a-1bd7-4b49-b547-5fe1356d675f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-25T13:26:01.0669739+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": "f6caea9d-2b53-40bf-8087-0415b1435bff",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-25T13:26:01.0669739+00:00"
}