Get a transaction security profile details
get
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles/{TransactionSecurityProfileId}
Request
Path Parameters
-
TransactionSecurityProfileId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : transactionSecurityProfiles-item-response
Type:
Show Source
object
-
Description: string
Maximum Length:
240
Description of the transaction security profile. -
EnabledFlag: boolean
Maximum Length:
1
Default Value:true
Indicates if transaction security profile is enabled or not. The valid values are Y or N. The default value is Y. -
GUID: string
Global unique identifier for the transaction security profile.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Maximum Length:
240
Transaction security profile name. -
SeedDataSource: string
Maximum Length:
512
Source path of the seed data for the transaction security profile. -
Sguid: string
Maximum Length:
32
Global unique identifier of the seed data associated to a transaction security profile. -
transactionSecurityProfileEntries: array
Transaction Security Profile Entries
Title:
Transaction Security Profile Entries
The transactionSecurityProfileEntries resource is a child of the transactionSecurityProfiles resource. It provides the entries for the transaction security profile. -
TransactionSecurityProfileId: integer
(int64)
Unique identifier of the transaction security profile.
-
ViewAllFlag: boolean
Maximum Length:
1
Default Value:false
Indicates if all the transactions can be viewed with a transaction security profile. The valid values are Y or N. The default value is N.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Transaction Security Profile Entries
Type:
array
Title:
Transaction Security Profile Entries
The transactionSecurityProfileEntries resource is a child of the transactionSecurityProfiles resource. It provides the entries for the transaction security profile.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : transactionSecurityProfiles-transactionSecurityProfileEntries-item-response
Type:
Show Source
object
-
AllSubCategorySelected: string
Maximum Length:
1
Default Value:N
Indicates if all subcategories are selected. The valid values are Y or N. The default value is N. -
Category: string
Read Only:
true
Maximum Length:255
Category for the transaction security profile entry. -
CategoryCode: string
Maximum Length:
100
Category code for the transaction security profile entry. -
ExcludeSelectedSubCategory: string
Maximum Length:
1
Default Value:N
Indicates if selected subcategories need to be excluded from the transaction security profile entry. Valid values are Y or N. The default value is N. -
Family: string
Maximum Length:
100
Family name in a transaction security profile entry. -
GUID: string
Global unique identifier of a transaction security profile entry.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SeedDataSource: string
Maximum Length:
512
Source path of the seed data associated with the transaction security profile entry. -
Sguid: string
Maximum Length:
32
Global unique identifier of the seed data associated with an entry for a transaction security profile. -
SubcategoryLabels: string
Read Only:
true
List of subcategories associated with a transaction security profile entry. -
TransactionSecurityProfileEntryId: integer
(int64)
Identifier of the transaction security profile entry.
-
TransactionSecurityProfileId: integer
(int64)
Identifier of the transaction security profile associated with an entry.
-
transactionSecurityProfileSubCategory: array
Transaction Security Profile Subcategory
Title:
Transaction Security Profile Subcategory
The transactionSecurityProfileSubCategory resource is a child of the transactionSecurityProfileEntries resource. It provides subcategories for an entry of the transaction security profile.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Transaction Security Profile Subcategory
Type:
array
Title:
Transaction Security Profile Subcategory
The transactionSecurityProfileSubCategory resource is a child of the transactionSecurityProfileEntries resource. It provides subcategories for an entry of the transaction security profile.
Show Source
Nested Schema : transactionSecurityProfiles-transactionSecurityProfileEntries-transactionSecurityProfileSubCategory-item-response
Type:
Show Source
object
-
GUID: string
Global unique identifier of the subcategory for a transaction security profile entry.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SeedDataSource: string
Maximum Length:
512
Source path of the seed data associated to a subcategory. -
SubCategoryCode: string
Maximum Length:
100
Code for the subcategory. -
TransactionSecurityProfileEntryId: integer
(int64)
Identifier of the transaction security profile entry associated with a subcategory.
-
TransactionSecurityProfileSubCategoryId: integer
(int64)
Identifier of the subcategory.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- transactionSecurityProfileEntries
-
Parameters:
- TransactionSecurityProfileId:
$request.path.TransactionSecurityProfileId
The transactionSecurityProfileEntries resource is a child of the transactionSecurityProfiles resource. It provides the entries for the transaction security profile. - TransactionSecurityProfileId: