Get an enumeration
get
/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations/{EnumName}
Request
Path Parameters
-
EnumName(required): string
The name of the enumeration.
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(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 : publicSectorOpaEnumerations-item-response
Type:
Show Source
object
-
ChildEnumName: string
Title:
Child Enumeration Name
Maximum Length:30
The name of the child enumeration. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the enumeration. -
CreatedOn: string
(date-time)
The date on which the enumeration was created.
-
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date on which the enumeration was created. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates if the enumeration is logically deleted. Valid values are Y for deleted, and N for existing enumeration. The default value is N. -
Description: string
Title:
Description
Maximum Length:100
The description of the enumeration. -
EnumName: string
Title:
Enumeration Name
Maximum Length:30
The name of the enumeration. -
EnumType: string
Title:
Enumeration Type
Maximum Length:10
The data type of the enumeration. -
EnumValueService: array
Enumeration Values
Title:
Enumeration Values
The enumeration values resource is used to view the values associated to a particular enumeration name. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The name of the user who last updated the enumeration. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date on which the enumeration was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwnerId: string
Maximum Length:
10
The identifier of the owner who is associated with the enumeration. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates if the enumeration is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified. -
UncertainValue: string
Title:
Uncertain Value
Maximum Length:40
Indicates that the value for the enumeration is uncertain. -
UsesCustomTable: string
Maximum Length:
1
Indicates if the enumeration uses a user-defined table. Valid values are Y or N. -
ViewObjectId: number
Title:
View Object ID
The identifier of the View object that is associated with the enumeration.
Nested Schema : Enumeration Values
Type:
array
Title:
Enumeration Values
The enumeration values resource is used to view the values associated to a particular enumeration name.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorOpaEnumerations-EnumValueService-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The name of the user who created the enumeration value. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date on which the enumeration value was created. -
DeletedFlag: string
Maximum Length:
1
Default Value:N
Indicates if the enumeration value is logically deleted. Valid values are Y for deleted, and N for an existing enumeration value. The default value is N. -
Description: string
Title:
Description
Maximum Length:30
The description of the enumeration value. -
EnumName: string
Title:
Enumeration Name
Maximum Length:30
The name of the enumeration that is associated with the enumeration value. -
EnumValue: string
Title:
Enumeration Value
Maximum Length:50
The value of the enumeration. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date on which the enumeration value was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the enumeration value. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwnerId: string
Maximum Length:
10
The identifier of the owner who is associated with the enumeration value. -
SeedDataLock: integer
(int32)
Default Value:
0
Indicates if the enumeration value is a seed data. Valid values are 0 for the data that is customer data, 1 for seed data that cannot be modified, and 2 indicates that the seed data can be modified.
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.
Links
- EnumValueService
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations/{EnumName}/child/EnumValueServiceParameters:
- EnumName:
$request.path.EnumName
The enumeration values resource is used to view the values associated to a particular enumeration name. - EnumName: