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": "da856cca-8ba6-4b2b-8a32-a6df34247bdf",
"jobs_id": "59ac8bc2-5ab5-4de4-a075-a5f7f775a983",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "fbec36f6-69cd-4487-8c30-b48487e518eb",
"_parent_id": "564ef459-42f5-477a-94cf-ac85db865dcb",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "0dcd4554-4c31-4efd-a40b-3709bf870d2b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0dcae5bb-23b6-4573-b9b0-a050e0a439bd",
"_parent_id": "d7ee59a0-33c0-44dd-b6c7-a5a7c6d13d1b",
"root_parent_id": "1a376a3f-5ccb-4f0e-ba84-bd3bacd6c5db",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9d96ba97-33c8-49a2-bce6-c43dab5613ca",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "62c27b22-12c1-413e-b11c-7e7f653fd55f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4b3089d4-8a31-4ca5-9128-23078d90db6d",
"_parent_code": "sample string 6",
"sales_organization_id": "7762c75b-b12e-4b11-a760-fa03afd5d14e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7b9e7ee7-594d-4f6e-a997-a8bfe3dfb608",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c56e14e-4458-4bf9-a550-68d30297da00",
"db_currency_id": "0eda16fd-048f-4883-bf26-66dcee311d7f",
"db_language_id": "e87de537-9970-423b-a353-351507a01fb6",
"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": "2025-11-24T12:37:41.0406873+00:00"
},
"modified_dateutc": "2025-11-24T12:37:41.0406873+00:00"
},
"equipment_model_id": "0951991b-3bb2-4a07-b8de-0d9f5f763ee5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4b58d965-9921-4685-bbab-a5053532de41",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "767ebcde-34b7-448c-9039-1e461e805d5e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8c53b109-ebea-4e22-ac42-6ab11e7d93a7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ef78715e-d782-4c03-a67a-19e6b079ab9b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7b9e7ee7-594d-4f6e-a997-a8bfe3dfb608",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c56e14e-4458-4bf9-a550-68d30297da00",
"db_currency_id": "0eda16fd-048f-4883-bf26-66dcee311d7f",
"db_language_id": "e87de537-9970-423b-a353-351507a01fb6",
"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": "2025-11-24T12:37:41.0406873+00:00"
},
"modified_dateutc": "2025-11-24T12:37:41.0406873+00:00"
},
"equipment_family_id": "8f5fc592-ac4f-417a-93fa-155151fdb5cc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "62c27b22-12c1-413e-b11c-7e7f653fd55f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4b3089d4-8a31-4ca5-9128-23078d90db6d",
"_parent_code": "sample string 6",
"sales_organization_id": "7762c75b-b12e-4b11-a760-fa03afd5d14e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7b9e7ee7-594d-4f6e-a997-a8bfe3dfb608",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c56e14e-4458-4bf9-a550-68d30297da00",
"db_currency_id": "0eda16fd-048f-4883-bf26-66dcee311d7f",
"db_language_id": "e87de537-9970-423b-a353-351507a01fb6",
"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": "2025-11-24T12:37:41.0406873+00:00"
},
"modified_dateutc": "2025-11-24T12:37:41.0406873+00:00"
},
"date_in_production_since": "2025-11-24T12:37:41.0406873+00:00",
"date_out_of_production_since": "2025-11-24T12:37:41.0406873+00:00",
"date_end_support": "2025-11-24T12:37:41.0406873+00:00",
"sales_organization_id": "89698be9-9110-4935-8ecc-eb14faa25cca",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7b9e7ee7-594d-4f6e-a997-a8bfe3dfb608",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c56e14e-4458-4bf9-a550-68d30297da00",
"db_currency_id": "0eda16fd-048f-4883-bf26-66dcee311d7f",
"db_language_id": "e87de537-9970-423b-a353-351507a01fb6",
"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": "2025-11-24T12:37:41.0406873+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": "2025-11-24T12:37:41.0406873+00:00"
},
"project_status_id": "5b25b2c2-8ef9-4c01-a5b5-4327a08ec65a",
"project_status_code": "sample string 10",
"project_status": {
"id": "6e8522bb-91a5-4c11-b78b-6aa5239c5c75",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3eff3dd6-9cc4-4ef1-8f1f-5c9dfc981c7e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7b9e7ee7-594d-4f6e-a997-a8bfe3dfb608",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c56e14e-4458-4bf9-a550-68d30297da00",
"db_currency_id": "0eda16fd-048f-4883-bf26-66dcee311d7f",
"db_language_id": "e87de537-9970-423b-a353-351507a01fb6",
"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": "2025-11-24T12:37:41.0406873+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-24T12:37:41.0406873+00:00"
},
"company_id": "c192bdc6-6495-4de3-b327-1bc98733bd7f",
"company_code": "sample string 12",
"db_address_id": "a794599b-a87f-43aa-a9dc-a43ccf88b9e8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d8422c42-5f7e-43cf-ad87-5615280c4165",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "86a527dc-bc8f-49fe-813f-c5283ae0e240",
"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": "2025-11-24T12:37:41.0406873+00:00",
"date_create": "2025-11-24T12:37:41.0406873+00:00",
"date_update": "2025-11-24T12:37:41.0406873+00:00",
"updated_by_user_id": "4607f75b-0ec0-43fe-9da9-b90fdbb56e41",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-24T12:37:41.0406873+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": "2025-11-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-24T12:37:41.0406873+00:00",
"date_last_job": "2025-11-24T12:37:41.0406873+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-24T12:37:41.0406873+00:00",
"modified_dateutc": "2025-11-24T12:37:41.0406873+00:00",
"is_mobile_installation": true
},
"job_type_id": "234a048a-7045-4bed-a9dc-f3cf719f0e0d",
"job_type_code": "sample string 7",
"job_type": {
"id": "81f860e8-f033-4980-8c65-a18d310fd8ba",
"name": "sample string 2",
"sales_organization_id": "0b4fbd30-6cf2-463b-aea8-274155130590",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-24T12:37:41.0406873+00:00",
"code": "sample string 7"
},
"job_priority_id": "da0afc08-55f1-4765-b784-9060d818c095",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3dc01db4-8183-4569-97c7-549031d53fc7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5982421f-1112-4343-96d9-91190233c891",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7b9e7ee7-594d-4f6e-a997-a8bfe3dfb608",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c56e14e-4458-4bf9-a550-68d30297da00",
"db_currency_id": "0eda16fd-048f-4883-bf26-66dcee311d7f",
"db_language_id": "e87de537-9970-423b-a353-351507a01fb6",
"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": "2025-11-24T12:37:41.0406873+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-24T12:37:41.0406873+00:00"
},
"job_status_id": "63ea81f5-8c26-4803-bf57-33a5370eac7e",
"job_status_code": "sample string 11",
"db_address_id": "43b07d17-63e3-4c81-8b45-d8ef31c1b574",
"contact_id": "48d7119f-3356-4481-bd90-e61bcbbb93d0",
"requested_by_company_id": "d676ffd4-7f80-49b9-8fbf-00fd9a0e35f9",
"requested_by_contact_id": "ce8df67e-d4c9-4f63-bb16-7cc1fc3f8aa2",
"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": "2025-11-24T12:37:41.0406873+00:00",
"due_date": "2025-11-24T12:37:41.0406873+00:00",
"date_create": "2025-11-24T12:37:41.0406873+00:00",
"date_update": "2025-11-24T12:37:41.0406873+00:00",
"date_closed": "2025-11-24T12:37:41.0406873+00:00",
"suggested_user_id": "640b59b0-14e9-4413-ac7a-1d35c4dffbb4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "71c84dcc-bd24-45be-ad20-d20461e33801",
"db_language_id": "aa8b2101-9281-42a6-b4c7-145cb18586fb",
"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": "2025-11-24T12:37:41.0406873+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "eb6b2d82-d7ec-412b-8aa6-6d82ac2c39b4",
"sales_organization": {
"id": "7b9e7ee7-594d-4f6e-a997-a8bfe3dfb608",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c56e14e-4458-4bf9-a550-68d30297da00",
"db_currency_id": "0eda16fd-048f-4883-bf26-66dcee311d7f",
"db_language_id": "e87de537-9970-423b-a353-351507a01fb6",
"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": "2025-11-24T12:37:41.0406873+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6f48b0ec-4c1b-41d5-be84-df01bd7c04db",
"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": "a5c0781c-cbcd-4500-a06b-819d1987948c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-24T12:37:41.0406873+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c36c1c62-7046-47a8-aff9-60c79981fde1"
},
"suggested_date_start": "2025-11-24T12:37:41.0406873+00:00",
"skill_id": "afe453d0-104d-439a-97b2-99a50262e144",
"skill_code": "sample string 32",
"skill": {
"id": "7e5b1263-3011-499b-aca2-4eea973e48e4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3c28f15f-fe25-4bc6-9446-cc47cda3b010",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7b9e7ee7-594d-4f6e-a997-a8bfe3dfb608",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1c56e14e-4458-4bf9-a550-68d30297da00",
"db_currency_id": "0eda16fd-048f-4883-bf26-66dcee311d7f",
"db_language_id": "e87de537-9970-423b-a353-351507a01fb6",
"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": "2025-11-24T12:37:41.0406873+00:00"
},
"modified_dateutc": "2025-11-24T12:37:41.0406873+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ff85e0f2-11da-42c9-a646-58110e2afafb",
"date_reported_by_company": "2025-11-24T12:37:41.0406873+00:00",
"id2": 36,
"company_id": "60d4eeb2-52c1-47c7-85f3-855ed2d2b489",
"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": "3ec74ae5-6558-4e80-8891-ddac8d2d09f3",
"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": "2025-11-24T12:37:41.0406873+00:00"
},
"work_instruction_details_id": "3a7799d3-8560-4313-9340-905d1446fd69",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7596e19e-645c-4f8e-b20c-e2aa673249ce",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ad1a01e2-3399-4c12-a3a3-12db762fe5ec",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-24T12:37:41.0406873+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": "78454dac-18bc-4303-84e9-8ccb3836d64e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-24T12:37:41.0406873+00:00"
}