Jump to

• Request
• Response

Create a data security privilege

post

/fscmRestApi/resources/11.13.18.05/publicSectorPrivileges

Request

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.
• Upsert-Mode:
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Attribute: string
  Maximum Length: 128

  The names of the attributes that need to be redacted.
• Entityobjectname: string
  Maximum Length: 80

  The name of the entityobject associated with the viewobject.
• Objectname: string
  Maximum Length: 80

  The name of the data security object.
• Privilegename: string
  Maximum Length: 400

  The name of the data security privilege.
• Privilegetype: string
  Maximum Length: 20

  Indicates the type of the data security privilege. A privilege can be of these types: standard, custom, column authorization, or redaction.
• RedactFormat: string
  Maximum Length: 20

  The format of the redacted attributes. Redaction format can be of multiple formats. For example, redact all digits, redact the last 3 digits, redact the last 4 digits, redact the complete string, redact the email address, and so on.
• Viewobjectname: string
  Maximum Length: 80

  The name of the viewobject associated with data security object.

{
    "type":"object",
    "properties":{
        "Entityobjectname":{
            "maxLength":"80",
            "type":"string",
            "description":"The name of the entityobject associated with the viewobject.",
            "nullable":false
        },
        "RedactFormat":{
            "maxLength":"20",
            "type":"string",
            "description":"The format of the redacted attributes. Redaction format can be of multiple formats. For example, redact all digits, redact the last 3 digits, redact the last 4 digits, redact the complete string, redact the email address, and so on.",
            "nullable":true
        },
        "Attribute":{
            "maxLength":"128",
            "type":"string",
            "description":"The names of the attributes that need to be redacted.",
            "nullable":true
        },
        "Viewobjectname":{
            "maxLength":"80",
            "type":"string",
            "description":"The name of the viewobject associated with data security object.",
            "nullable":false
        },
        "Privilegetype":{
            "maxLength":"20",
            "type":"string",
            "description":"Indicates the type of the data security privilege. A privilege can be of these types: standard, custom, column authorization, or redaction.",
            "nullable":false
        },
        "Privilegename":{
            "maxLength":"400",
            "type":"string",
            "description":"The name of the data security privilege.",
            "nullable":false
        },
        "Objectname":{
            "maxLength":"80",
            "type":"string",
            "description":"The name of the data security object.",
            "nullable":false
        }
    }
}

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 : publicSectorPrivileges-item-response

Type: object

Show Source

• Attribute: string
  Maximum Length: 128

  The names of the attributes that need to be redacted.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the data security object.
• CreationDate: string (date-time)
  Read Only: true

  The date on which the data security object was created.
• Entityobjectname: string
  Maximum Length: 80

  The name of the entityobject associated with the viewobject.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date on which the data security object was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the data security object.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Objectname: string
  Maximum Length: 80

  The name of the data security object.
• Privilegename: string
  Maximum Length: 400

  The name of the data security privilege.
• Privilegetype: string
  Maximum Length: 20

  Indicates the type of the data security privilege. A privilege can be of these types: standard, custom, column authorization, or redaction.
• RedactFormat: string
  Maximum Length: 20

  The format of the redacted attributes. Redaction format can be of multiple formats. For example, redact all digits, redact the last 3 digits, redact the last 4 digits, redact the complete string, redact the email address, and so on.
• Viewobjectname: string
  Maximum Length: 80

  The name of the viewobject associated with data security object.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the data security object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date on which the data security object was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Entityobjectname":{
            "maxLength":"80",
            "type":"string",
            "description":"The name of the entityobject associated with the viewobject.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the data security object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RedactFormat":{
            "maxLength":"20",
            "type":"string",
            "description":"The format of the redacted attributes. Redaction format can be of multiple formats. For example, redact all digits, redact the last 3 digits, redact the last 4 digits, redact the complete string, redact the email address, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "Attribute":{
            "maxLength":"128",
            "type":"string",
            "description":"The names of the attributes that need to be redacted.",
            "nullable":true,
            "x-queryable":true
        },
        "Viewobjectname":{
            "maxLength":"80",
            "type":"string",
            "description":"The name of the viewobject associated with data security object.",
            "nullable":false,
            "x-queryable":true
        },
        "Privilegetype":{
            "maxLength":"20",
            "type":"string",
            "description":"Indicates the type of the data security privilege. A privilege can be of these types: standard, custom, column authorization, or redaction.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Privilegename":{
            "maxLength":"400",
            "type":"string",
            "description":"The name of the data security privilege.",
            "nullable":false,
            "x-queryable":true
        },
        "Objectname":{
            "maxLength":"80",
            "type":"string",
            "description":"The name of the data security object.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date on which the data security object was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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 : 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."
        }
    }
}

Back to Top