Get all data security profiles
get
/fscmRestApi/resources/11.13.18.05/hedDataSecurityProfiles
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- ByKeywordFinder Finds all data security profiles that match the specified keyword.
Finder Variables- Keyword; string; Finds all data security profiles that match the keyword.
- ByPageElementFinder Finds all data security profiles that match the specified page element.
Finder Variables- PageElementId; integer; Finds all data security profiles that match the specified page element ID.
- ByPageFinder Finds all data security profiles that match the specified page.
Finder Variables- PageId; integer; Finds all data security profiles that match the specified page ID.
- PrimaryKey Finds the data security profile that matches the primary key criteria specified.
Finder Variables- ProfileId; integer; The unique identifier of the data security profile.
- ByKeywordFinder Finds all data security profiles that match the specified keyword.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- BusinessObjectId; integer; Unique identifier of the business object used to configure data security.
- BusinessObjectName; string; Name of the business object.
- CreatedBy; string; An attribute to store the user name of the person who created the record.
- CreationDate; string; Date when the record was created.
- FunctionalAreaCode; string; The unique identifier code of the functional area under which the application pages are categorized.
- FunctionalAreaMeaning; string; Meaning of the functional area of the security profile.
- GlobalSetFlag; boolean; Attribute to indicate a global set.
- LastUpdateDate; string; Date when the record was last updated.
- LastUpdatedBy; string; User name of the person who last updated the record.
- ProfileDescription; string; Description of the security profile.
- ProfileId; integer; Unique identifier of the security profile used for data security.
- ProfileName; string; Name of the security profile.
- SeedDataLock; integer; Indicates whether the record is predefined. The value 0 means the record isn't predefined. The value 1 means the record is predefined and can't be updated. A value greater than 1 means the record is predefined but can be updated.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : hedDataSecurityProfiles
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : hedDataSecurityProfiles-item-response
Type:
Show Source
object
-
BusinessObjectId: integer
(int64)
Title:
Business Object
Unique identifier of the business object used to configure data security. -
BusinessObjectName: string
Title:
Business Object
Maximum Length:240
Name of the business object. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
An attribute to store the user name of the person who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the record was created. -
FunctionalAreaCode: string
Title:
Functional Area Code
Read Only:true
Maximum Length:30
The unique identifier code of the functional area under which the application pages are categorized. -
FunctionalAreaMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Meaning of the functional area of the security profile. -
GlobalSetFlag: boolean
Title:
Global Set Indicator
Maximum Length:1
Default Value:false
Attribute to indicate a global set. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User name of the person who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProfileDescription: string
Title:
Security Profile Description
Maximum Length:1000
Description of the security profile. -
profileFields: array
Profile Fields
Title:
Profile Fields
The profile fields resource fields provide a complete list of fields that can be used to define the data conditions for the data security profile. -
ProfileId: integer
(int64)
Title:
Security Profile ID
Read Only:true
Unique identifier of the security profile used for data security. -
ProfileName: string
Title:
Data Profile Name
Maximum Length:100
Name of the security profile. -
SeedDataLock: integer
(int32)
Read Only:
true
Default Value:0
Indicates whether the record is predefined. The value 0 means the record isn't predefined. The value 1 means the record is predefined and can't be updated. A value greater than 1 means the record is predefined but can be updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Profile Fields
Type:
array
Title:
Profile Fields
The profile fields resource fields provide a complete list of fields that can be used to define the data conditions for the data security profile.
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.
Nested Schema : hedDataSecurityProfiles-profileFields-item-response
Type:
Show Source
object
-
AssignmentFieldName: string
Title:
Assignment Field Name
Read Only:true
Maximum Length:50
Name of the assignment field used on the security profile. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
An attribute to store the user name of the person who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the record was created. -
FieldDataType: string
Title:
Field Data Type
Read Only:true
Maximum Length:20
Data type of the field used for the security profile. -
FieldDescription: string
Title:
Field Description
Read Only:true
Maximum Length:1000
Description of the field used for the security profile. -
FieldDisplay: string
Title:
Field Display
Read Only:true
Maximum Length:100
Display value of the field used for the security profile. -
FieldId: integer
(int64)
Title:
Field
Unique identifier of the field. -
FieldLOVDisplayFields: string
Title:
Field LOV Display Fields
Read Only:true
Maximum Length:50
The comma separated list of list of value resource field names that's used to get the value from for display purposes. -
FieldLOVResourcePath: string
Title:
Field LOV Resource Path
Read Only:true
Maximum Length:250
The list of values resource path to get the list of values for this field. -
FieldLOVSourceField: string
Title:
Field LOV Source Field
Read Only:true
Maximum Length:50
The field name of the list of value resource to get the value from for the assignment to the business object field. -
FieldOperatorCode: string
Title:
Field Operator Code
Read Only:true
Maximum Length:30
Unique identifier of the field operator used for the security profile. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User name of the person who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProfileFieldId: integer
(int64)
Title:
Profile Field ID
Read Only:true
Unique identifier of the security profile. -
SupportMultiValueFlag: boolean
Title:
Field Multiple Value Indicator
Read Only:true
Maximum Length:1
Field used to store the indicator for multiple values for the security profile. -
SupportNullValueFlag: boolean
Title:
Field Null Value Indicator
Read Only:true
Maximum Length:1
Field used to store the indicator for a Null attribute for the security profile.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source