Jump to

• Request
• Response

Update an entry for a transaction security profile

patch

/hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles/{TransactionSecurityProfileId}/child/transactionSecurityProfileEntries/{TransactionSecurityProfileEntryId}

Request

Path Parameters

• TransactionSecurityProfileEntryId(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=
• 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=

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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.
• 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.
• 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.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Category code for the transaction security profile entry.",
            "nullable":true
        },
        "SeedDataSource":{
            "maxLength":"512",
            "type":"string",
            "description":"Source path of the seed data associated with the transaction security profile entry.",
            "nullable":true
        },
        "ExcludeSelectedSubCategory":{
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"N"
        },
        "GUID":{
            "type":"string",
            "description":"Global unique identifier of a transaction security profile entry.",
            "nullable":true,
            "x-queryable":false
        },
        "Family":{
            "maxLength":"100",
            "type":"string",
            "description":"Family name in a transaction security profile entry.",
            "nullable":true
        },
        "AllSubCategorySelected":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if all subcategories are selected. The valid values are Y or N. The default value is N.",
            "nullable":true,
            "default":"N"
        },
        "Sguid":{
            "maxLength":"32",
            "type":"string",
            "description":"Global unique identifier of the seed data associated with an entry for a transaction security profile.",
            "nullable":true
        },
        "transactionSecurityProfileSubCategory":{
            "title":"Transaction Security Profile Subcategory",
            "type":"array",
            "description":"The transactionSecurityProfileSubCategory resource is a child of the transactionSecurityProfileEntries resource. It provides subcategories for an entry of the transaction security profile.",
            "items":{
                "$ref":"#/components/schemas/transactionSecurityProfiles-transactionSecurityProfileEntries-transactionSecurityProfileSubCategory-item-patch-request"
            }
        }
    }
}

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

• Array of: object transactionSecurityProfiles-transactionSecurityProfileEntries-transactionSecurityProfileSubCategory-item-patch-request

{
    "title":"Transaction Security Profile Subcategory",
    "type":"array",
    "description":"The transactionSecurityProfileSubCategory resource is a child of the transactionSecurityProfileEntries resource. It provides subcategories for an entry of the transaction security profile.",
    "items":{
        "$ref":"#/components/schemas/transactionSecurityProfiles-transactionSecurityProfileEntries-transactionSecurityProfileSubCategory-item-patch-request"
    }
}

Nested Schema : transactionSecurityProfiles-transactionSecurityProfileEntries-transactionSecurityProfileSubCategory-item-patch-request

Type: object

Show Source

• GUID: string
  Global unique identifier of the subcategory for a transaction security profile entry.
• SeedDataSource: string
  Maximum Length: 512

  Source path of the seed data associated to a subcategory.
• SubCategoryCode: string
  Maximum Length: 100

  Code for the subcategory.

{
    "type":"object",
    "properties":{
        "GUID":{
            "type":"string",
            "description":"Global unique identifier of the subcategory for a transaction security profile entry.",
            "nullable":true,
            "x-queryable":false
        },
        "SeedDataSource":{
            "maxLength":"512",
            "type":"string",
            "description":"Source path of the seed data associated to a subcategory.",
            "nullable":true
        },
        "SubCategoryCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Code for the subcategory.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : transactionSecurityProfiles-transactionSecurityProfileEntries-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Category code for the transaction security profile entry.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionSecurityProfileId":{
            "type":"integer",
            "description":"Identifier of the transaction security profile associated with an entry.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Category":{
            "maxLength":"255",
            "type":"string",
            "description":"Category for the transaction security profile entry.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SeedDataSource":{
            "maxLength":"512",
            "type":"string",
            "description":"Source path of the seed data associated with the transaction security profile entry.",
            "nullable":true,
            "x-queryable":true
        },
        "ExcludeSelectedSubCategory":{
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "GUID":{
            "type":"string",
            "description":"Global unique identifier of a transaction security profile entry.",
            "nullable":true,
            "x-queryable":false
        },
        "transactionSecurityProfileSubCategory":{
            "title":"Transaction Security Profile Subcategory",
            "type":"array",
            "description":"The transactionSecurityProfileSubCategory resource is a child of the transactionSecurityProfileEntries resource. It provides subcategories for an entry of the transaction security profile.",
            "items":{
                "$ref":"#/components/schemas/transactionSecurityProfiles-transactionSecurityProfileEntries-transactionSecurityProfileSubCategory-item-response"
            }
        },
        "SubcategoryLabels":{
            "type":"string",
            "description":"List of subcategories associated with a transaction security profile entry.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionSecurityProfileEntryId":{
            "type":"integer",
            "description":"Identifier of the transaction security profile entry.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Family":{
            "maxLength":"100",
            "type":"string",
            "description":"Family name in a transaction security profile entry.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AllSubCategorySelected":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if all subcategories are selected. The valid values are Y or N. The default value is N.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "Sguid":{
            "maxLength":"32",
            "type":"string",
            "description":"Global unique identifier of the seed data associated with an entry for a transaction security profile.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object transactionSecurityProfiles-transactionSecurityProfileEntries-transactionSecurityProfileSubCategory-item-response

{
    "title":"Transaction Security Profile Subcategory",
    "type":"array",
    "description":"The transactionSecurityProfileSubCategory resource is a child of the transactionSecurityProfileEntries resource. It provides subcategories for an entry of the transaction security profile.",
    "items":{
        "$ref":"#/components/schemas/transactionSecurityProfiles-transactionSecurityProfileEntries-transactionSecurityProfileSubCategory-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : transactionSecurityProfiles-transactionSecurityProfileEntries-transactionSecurityProfileSubCategory-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "TransactionSecurityProfileEntryId":{
            "type":"integer",
            "description":"Identifier of the transaction security profile entry associated with a subcategory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GUID":{
            "type":"string",
            "description":"Global unique identifier of the subcategory for a transaction security profile entry.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SeedDataSource":{
            "maxLength":"512",
            "type":"string",
            "description":"Source path of the seed data associated to a subcategory.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionSecurityProfileSubCategoryId":{
            "type":"integer",
            "description":"Identifier of the subcategory.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubCategoryCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Code for the subcategory.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

transactionSecurityProfileSubCategory

Operation: /hcmRestApi/resources/11.13.18.05/transactionSecurityProfiles/{TransactionSecurityProfileId}/child/transactionSecurityProfileEntries/{TransactionSecurityProfileEntryId}/child/transactionSecurityProfileSubCategory

Parameters:

• TransactionSecurityProfileEntryId: $request.path.TransactionSecurityProfileEntryId
• TransactionSecurityProfileId: $request.path.TransactionSecurityProfileId

The transactionSecurityProfileSubCategory resource is a child of the transactionSecurityProfileEntries resource. It provides subcategories for an entry of the transaction security profile.

Back to Top