Get a lookup type
get
/fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes/{publicSectorLookupTypesUniqID}
Request
Path Parameters
-
publicSectorLookupTypesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- LookupType and ViewApplicationId ---for the Lookup Types resource and used to uniquely identify an instance of Lookup Types. The client should not generate the hash key value. Instead, the client should query on the Lookup Types collection resource with a filter on the primary key values in order to navigate to a specific instance of Lookup Types.
For example: publicSectorLookupTypes?q=LookupType=<value1>;ViewApplicationId=<value2>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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-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
Links
- PscLookupValue
-
Parameters:
- publicSectorLookupTypesUniqID:
$request.path.publicSectorLookupTypesUniqID
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. - publicSectorLookupTypesUniqID: