Create a transaction security profile
post
/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles
Request
Header Parameters
-
Metadata-Context: string
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: string
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.
-
Upsert-Mode: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
Description: string
Maximum Length:
240Description of the transaction security profile. -
EnabledFlag: boolean
Maximum Length:
1Default Value:trueIndicates 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.
-
Name(required): string
Maximum Length:
240Transaction security profile name. -
SeedDataSource: string
Maximum Length:
512Source path of the seed data for the transaction security profile. -
Sguid: string
Maximum Length:
32Global unique identifier of the seed data associated to a transaction security profile. -
transactionSecurityProfileEntries: array
Transaction Security Profile Entries
Title:
Transaction Security Profile EntriesThe 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:
1Default Value:falseIndicates 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 : Transaction Security Profile Entries
Type:
arrayTitle:
Transaction Security Profile EntriesThe transactionSecurityProfileEntries resource is a child of the transactionSecurityProfiles resource. It provides the entries for the transaction security profile.
Show Source
Nested Schema : schema
Type:
Show Source
object-
AllSubCategorySelected: string
Maximum Length:
1Default Value:NIndicates if all subcategories are selected. The valid values are Y or N. The default value is N. -
CategoryCode: string
Maximum Length:
100Category code for the transaction security profile entry. -
ExcludeSelectedSubCategory: string
Maximum Length:
1Default Value:NIndicates 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:
100Family name in a transaction security profile entry. -
GUID: string
Global unique identifier of a transaction security profile entry.
-
SeedDataSource: string
Maximum Length:
512Source path of the seed data associated with the transaction security profile entry. -
Sguid: string
Maximum Length:
32Global unique identifier of the seed data associated with an entry for a transaction security profile. -
TransactionSecurityProfileEntryId: integer
(int64)
Identifier of the transaction security profile entry.
-
TransactionSecurityProfileId(required): integer
(int64)
Identifier of the transaction security profile associated with an entry.
-
transactionSecurityProfileSubCategory: array
Transaction Security Profile Subcategory
Title:
Transaction Security Profile SubcategoryThe transactionSecurityProfileSubCategory resource is a child of the transactionSecurityProfileEntries resource. It provides subcategories for an entry of the transaction security profile.
Nested Schema : Transaction Security Profile Subcategory
Type:
arrayTitle:
Transaction Security Profile SubcategoryThe transactionSecurityProfileSubCategory resource is a child of the transactionSecurityProfileEntries resource. It provides subcategories for an entry of the transaction security profile.
Show Source
Nested Schema : schema
Type:
Show Source
object-
GUID: string
Global unique identifier of the subcategory for a transaction security profile entry.
-
SeedDataSource: string
Maximum Length:
512Source path of the seed data associated to a subcategory. -
SubCategoryCode: string
Maximum Length:
100Code for the subcategory. -
TransactionSecurityProfileEntryId: integer
(int64)
Identifier of the transaction security profile entry associated with a subcategory.
-
TransactionSecurityProfileSubCategoryId: integer
(int64)
Identifier of the subcategory.
Response
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:
240Description of the transaction security profile. -
EnabledFlag: boolean
Maximum Length:
1Default Value:trueIndicates 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:
LinksThe link relations associated with the resource instance. -
Name: string
Maximum Length:
240Transaction security profile name. -
SeedDataSource: string
Maximum Length:
512Source path of the seed data for the transaction security profile. -
Sguid: string
Maximum Length:
32Global unique identifier of the seed data associated to a transaction security profile. -
transactionSecurityProfileEntries: array
Transaction Security Profile Entries
Title:
Transaction Security Profile EntriesThe 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:
1Default Value:falseIndicates 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Transaction Security Profile Entries
Type:
arrayTitle:
Transaction Security Profile EntriesThe 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 referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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:
1Default Value:NIndicates if all subcategories are selected. The valid values are Y or N. The default value is N. -
Category: string
Read Only:
trueMaximum Length:255Category for the transaction security profile entry. -
CategoryCode: string
Maximum Length:
100Category code for the transaction security profile entry. -
ExcludeSelectedSubCategory: string
Maximum Length:
1Default Value:NIndicates 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:
100Family name in a transaction security profile entry. -
GUID: string
Global unique identifier of a transaction security profile entry.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SeedDataSource: string
Maximum Length:
512Source path of the seed data associated with the transaction security profile entry. -
Sguid: string
Maximum Length:
32Global unique identifier of the seed data associated with an entry for a transaction security profile. -
SubcategoryLabels: string
Read Only:
trueList 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 SubcategoryThe transactionSecurityProfileSubCategory resource is a child of the transactionSecurityProfileEntries resource. It provides subcategories for an entry of the transaction security profile.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Transaction Security Profile Subcategory
Type:
arrayTitle:
Transaction Security Profile SubcategoryThe 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:
LinksThe link relations associated with the resource instance. -
SeedDataSource: string
Maximum Length:
512Source path of the seed data associated to a subcategory. -
SubCategoryCode: string
Maximum Length:
100Code 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:
arrayTitle:
LinksThe 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: