Get all lookup types
get
/fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes
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:- PrimaryKey: Finds a lookup type that matches the primary key criteria specified.
Finder Variables:- LookupType; string; The lookup type.
- ViewApplicationId; integer; The unique application identifier.
- simpleSearchFinder: Finds lookup types that match the keyword specified.
Finder Variables:- value; string; The keyword used to find a lookup type such as lookup code or meaning.
- PrimaryKey: Finds a lookup type that matches the primary key criteria specified.
-
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:- CreatedBy; string; The user who created the lookup type.
- CreationDate; string; The date and time on which the lookup type was created.
- CustomizationLevel; string; The configuration level code such as system level or user level.
- Description; string; The description of the lookup type code.
- LastUpdateDate; string; The date on which the lookup type was last updated.
- LastUpdatedBy; string; The user who last updated the lookup type.
- LookupType; string; The lookup type code.
- Meaning; string; The meaning of the lookup type code.
- ModuleId; string; The unique module identifier associated with a logical business area such as billing or payment.
- ReferenceGroupName; string; The reference group name.
- UserModuleName; string; The module name displayed to the user.
- ViewApplicationId; integer; The application ID associated with product like permits.
-
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:
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 : publicSectorLookupTypes
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 : publicSectorLookupTypes-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the lookup type. -
CreationDate: string
(date-time)
Read Only:
true
The date and time on which the lookup type was created. -
CustomizationLevel: string
Title:
Configuration Level
Maximum Length:1
Default Value:U
The configuration level code such as system level or user level. -
Description: string
Title:
Description
Maximum Length:240
The description of the lookup type code. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date on which the lookup type was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the lookup type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupType: string
Title:
Lookup Type
Maximum Length:30
The lookup type code. -
Meaning: string
Title:
Meaning
Maximum Length:80
The meaning of the lookup type code. -
ModuleId: string
Title:
Module
Maximum Length:32
The unique module identifier associated with a logical business area such as billing or payment. -
PscLookupValue: array
Lookup Values
Title:
Lookup Values
The lookup value resource is used to view, create, delete or modify lookup values associated with a lookup type. The object stores lookup value information such as lookup code and meaning. -
ReferenceGroupName: string
Title:
Reference Group Name
Maximum Length:30
The reference group name. -
UserModuleName: string
Title:
User Module Name
Read Only:true
Maximum Length:512
The module name displayed to the user. -
ViewApplicationId: integer
(int64)
Title:
Application
Default Value:10560
The application ID associated with product like permits.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Lookup Values
Type:
array
Title:
Lookup Values
The lookup value resource is used to view, create, delete or modify lookup values associated with a lookup type. The object stores lookup value information such as lookup code and meaning.
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 : publicSectorLookupTypes-PscLookupValue-item-response
Type:
Show Source
object
-
AttributeCategory: string
Title:
Attribute Category
Maximum Length:30
The attribute category code. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The date and time on which the lookup value was created. -
CreationDate: string
(date-time)
Read Only:
true
The user who created the lookup value. -
Description: string
Title:
Description
Maximum Length:240
The description of the lookup value code. -
DisplaySequence: integer
(int64)
Title:
Display Sequence
The order in which lookup types are displayed. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Default Value:true
Indicates whether a lookup value is enabled. The default value is true. -
EndDateActive: string
(date)
Title:
End Date
The date on which the lookup value code becomes inactive. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date on which the lookup value was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the lookup value. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupCode: string
Title:
Lookup Code
Maximum Length:30
The lookup value code. -
LookupType: string
Title:
Lookup Type
Maximum Length:30
The lookup type code. -
Meaning: string
Title:
Meaning
Maximum Length:80
The meaning of the lookup value code. -
SetId: integer
(int64)
The unique identifier for a set of lookups.
-
StartDateActive: string
(date)
Title:
Start Date
The date on which the lookup value code becomes active. -
Tag: string
Title:
Tag
Maximum Length:150
The tag of the lookup value code. Tags on lookup codes enable you to add a label to your lookup codes. A tag can be used to categorize lookups based on facilitating searches or guiding how a lookup should be used. -
ViewApplicationId: integer
(int64)
Title:
Application
The unique application identifier associated with a product.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source