Jump to

• Request
• Response

Create a data security instance

post

/fscmRestApi/resources/11.13.18.05/publicSectorInstances

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:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

Supported Media Types

• application/json

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• Entityobjectname: string
  Maximum Length: 80

  The name of the entity object associated with the view object.
• Instancesetname: string
  Maximum Length: 30

  The name of the instance set, which uniquely identifies a row (or rows) of the secure object, represented by a SQL predicate.
• Objectname: string
  Maximum Length: 80

  The name of the data security object.
• Predicate: string
  Maximum Length: 4000

  The SQL predicate that uniquely identifies a row (or rows) of the secured object.
• Viewobjectname: string
  Maximum Length: 80

  The name of the view object associated with the data security object.
• Xformpredicate: string
  Maximum Length: 4000

  The transformed SQL predicate that uniquely identifies a row (or rows) of the secured object.

{
    "type":"object",
    "properties":{
        "Instancesetname":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the instance set, which uniquely identifies a row (or rows) of the secure object, represented by a SQL predicate.",
            "nullable":false
        },
        "Entityobjectname":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the entity object associated with the view object.",
            "nullable":false
        },
        "Xformpredicate":{
            "maxLength":4000,
            "type":"string",
            "description":"The transformed SQL predicate that uniquely identifies a row (or rows) of the secured object.",
            "nullable":true
        },
        "Viewobjectname":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the view object associated with the data security object.",
            "nullable":false
        },
        "Objectname":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the data security object.",
            "nullable":false
        },
        "Predicate":{
            "maxLength":4000,
            "type":"string",
            "description":"The SQL predicate that uniquely identifies a row (or rows) of the secured object.",
            "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(required):
  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(required):
  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 : publicSectorInstances-item-response

Type: object

Show Source

• 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 entity object associated with the view object.
• Instancesetname: string
  Maximum Length: 30

  The name of the instance set, which uniquely identifies a row (or rows) of the secure object, represented by a SQL predicate.
• 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.
• Predicate: string
  Maximum Length: 4000

  The SQL predicate that uniquely identifies a row (or rows) of the secured object.
• Viewobjectname: string
  Maximum Length: 80

  The name of the view object associated with the data security object.
• Xformpredicate: string
  Maximum Length: 4000

  The transformed SQL predicate that uniquely identifies a row (or rows) of the secured 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
        },
        "Instancesetname":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the instance set, which uniquely identifies a row (or rows) of the secure object, represented by a SQL predicate.",
            "nullable":false,
            "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 entity object associated with the view object.",
            "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
        },
        "Xformpredicate":{
            "maxLength":4000,
            "type":"string",
            "description":"The transformed SQL predicate that uniquely identifies a row (or rows) of the secured object.",
            "nullable":true,
            "x-queryable":true
        },
        "Viewobjectname":{
            "maxLength":80,
            "type":"string",
            "description":"The name of the view object associated with the data security object.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "Predicate":{
            "maxLength":4000,
            "type":"string",
            "description":"The SQL predicate that uniquely identifies a row (or rows) of the secured object.",
            "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 : 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