Create a data security policy
post
/fscmRestApi/resources/11.13.18.05/publicSectorPolicies
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
Root Schema : schema
Type:
Show Source
object
-
EndDate: string
(date-time)
The date by which the data security policy is no longer valid.
-
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 that 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. -
ParameterList: string
Maximum Length:
255
The names of the data security parameters for parameterized instance sets. -
PolicyName: string
Maximum Length:
80
The name of the data security policy. -
PrimaryKeyValueList: string
Maximum Length:
255
The names of the primary key values for single instance sets. -
Privilege: string
Maximum Length:
400
The name of the data security privilege. -
RoleGUID: string
Maximum Length:
128
The GUID of the application role. -
Rolename: string
Maximum Length:
256
The name of the application role. -
Ruletype: string
Maximum Length:
15
The names of various types of rules. Valid values are: single, multiple, and allvalues. -
StartDate: string
(date-time)
The date at which the data security policy gets enforced.
-
Viewobjectname: string
Maximum Length:
80
The name of the view object associated with data security object.
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 : publicSectorPolicies-item-response
Type:
Show Source
object
-
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. -
EndDate: string
(date-time)
The date by which the data security policy is no longer valid.
-
Entityobjectname: string
Maximum Length:
80
The name of the entity object associated with the view object. -
EntityobjectnameInst: string
Read Only:
true
Maximum Length:80
The name of the entity object associated with the view object. -
EntityobjectnameObject: string
Read Only:
true
Maximum Length:128
The name of the entity object associated with the view object. -
Instancesetname: string
Maximum Length:
30
The name of the instance set that uniquely identifies a row (or rows) of the secure object, represented by a SQL predicate. -
InstancesetnameInst: string
Read Only:
true
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. -
ParameterList: string
Maximum Length:
255
The names of the data security parameters for parameterized instance sets. -
PolicyName: string
Maximum Length:
80
The name of the data security policy. -
Predicate: string
Read Only:
true
Maximum Length:4000
The SQL predicate that uniquely identifies a row (or rows) of the secured object. -
PrimaryKeyFieldList: string
Read Only:
true
Maximum Length:256
The names of the primary key fields of the data security object. -
PrimaryKeyValueList: string
Maximum Length:
255
The names of the primary key values for single instance sets. -
Privilege: string
Maximum Length:
400
The name of the data security privilege. -
RoleGUID: string
Maximum Length:
128
The GUID of the application role. -
Rolename: string
Maximum Length:
256
The name of the application role. -
Ruletype: string
Maximum Length:
15
The names of various types of rules. Valid values are: single, multiple, and allvalues. -
StartDate: string
(date-time)
The date at which the data security policy gets enforced.
-
Viewobjectname: string
Maximum Length:
80
The name of the view object associated with data security object. -
ViewobjectnameInst: string
Read Only:
true
Maximum Length:80
The name of the view object associated with a data security object. -
ViewobjectnameObject: string
Read Only:
true
Maximum Length:128
The name of the view object associated with data security object.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.