Create a filter criterion
post
/fscmRestApi/resources/11.13.18.05/publicSectorUserDefinedFilters
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
-
ComponentElementId: string
Maximum Length:
100
The unique identifier for the element value of the component on the page. -
Criteria: string
(byte)
The filter criteria details in JSON string format.
-
CriteriaSource: string
Maximum Length:
30
This flag is to distinguish whether the filter criteria is for advanced search or filter search. -
FilterId: integer
(int64)
The unique identifier for search filter criteria.
-
Name: string
Maximum Length:
100
The filter name entered by a user for a specific table component. -
ProfileId: integer
(int64)
The unique identifier of the profile of the user who owns the search filter cirteria.
-
UserId: string
Maximum Length:
64
The unique identifier of the user who own this search filter criteria.
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.
Root Schema : publicSectorUserDefinedFilters-item-response
Type:
Show Source
object
-
ComponentElementId: string
Maximum Length:
100
The unique identifier for the element value of the component on the page. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the row was created. -
Criteria: string
(byte)
The filter criteria details in JSON string format.
-
CriteriaSource: string
Maximum Length:
30
This flag is to distinguish whether the filter criteria is for advanced search or filter search. -
FilterId: integer
(int64)
The unique identifier for search filter criteria.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the row was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Maximum Length:
100
The filter name entered by a user for a specific table component. -
ProfileId: integer
(int64)
The unique identifier of the profile of the user who owns the search filter cirteria.
-
UserId: string
Maximum Length:
64
The unique identifier of the user who own this search filter criteria.
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.