Create a lookup code
post
http://servername/fscmRestApi/resources/11.13.18.05/setEnabledLookups/{LookupType}/child/lookupCodes
Request
Path Parameters
-
LookupType(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context: string
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: string
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: string
When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Root Schema : schema
Match All
Show Source
-
object
Set Enabled Lookup Codes VO
Title:
Set Enabled Lookup Codes VO -
object
type
Nested Schema : Set Enabled Lookup Codes VO
Type:
objectTitle:
Show Source
Set Enabled Lookup Codes VO-
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Read Only:
trueThe date on which the record was created. -
Description: string
Title:
DescriptionMaximum Length:240The description of the lookup. -
DisplaySequence: integer
(int64)
Title:
Display SequenceThe sequence in which the lookup code should be displayed. -
EnabledFlag: string
Title:
EnabledMaximum Length:1Default Value:YIndicates if the lookup code is enabled or not. -
EndDateActive: string
(date)
Title:
End DateThe date on which the lookup code is no longer active. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date on which the record was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the record. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login credentials of the user who last updated the record. -
LookupCode: string
Title:
Lookup CodeMaximum Length:30The unique code that identifies the lookup. -
Meaning: string
Title:
MeaningMaximum Length:80The meaning of the lookup code. -
SetCode: string
Title:
Set CodeRead Only:trueMaximum Length:30The set code that identifies the lookup code. -
SetId: integer
(int64)
The unique identifier of the set.
-
StartDateActive: string
(date)
Title:
Start DateThe date on which the lookup code becomes active. -
Tag: string
Title:
TagMaximum Length:150An optional tag used to filter the lookup codes.
Nested Schema : lookupsDFF
Type:
Show Source
array-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context" }
Nested Schema : translations
Type:
Show Source
array-
Array of:
object Set Enabled Lookup Codes Translations VO
Title:
Set Enabled Lookup Codes Translations VO
Nested Schema : Discriminator: __FLEX_Context
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30 -
__FLEX_Context_DisplayValue: string
Title:
Context Segment -
loc: string
Title:
locMaximum Length:150 -
LookupCode: string
Title:
Lookup CodeMaximum Length:30 -
LookupType: string
Title:
Lookup TypeMaximum Length:30 -
sd1: string
Title:
sd1Maximum Length:150 -
SetId: integer
(int64)
Title:
Reference Data Set -
ViewApplicationId: integer
(int64)
Nested Schema : Set Enabled Lookup Codes Translations VO
Type:
objectTitle:
Show Source
Set Enabled Lookup Codes Translations VO-
CreatedBy: string
Read Only:
trueMaximum Length:64 -
CreationDate: string
(date-time)
Read Only:
true -
Description: string
Maximum Length:
240 -
Language: string
Maximum Length:
30 -
LastUpdateDate: string
(date-time)
Read Only:
true -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64 -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32 -
Meaning: string
Maximum Length:
80 -
SourceLang: string
Maximum Length:
4
Root Schema : schema
Match All
Show Source
-
object
Set Enabled Lookup Codes VO
Title:
Set Enabled Lookup Codes VO -
object
type
Nested Schema : Set Enabled Lookup Codes VO
Type:
objectTitle:
Show Source
Set Enabled Lookup Codes VO-
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Read Only:
trueThe date on which the record was created. -
Description: string
Title:
DescriptionMaximum Length:240The description of the lookup. -
DisplaySequence: integer
(int64)
Title:
Display SequenceThe sequence in which the lookup code should be displayed. -
EnabledFlag: string
Title:
EnabledMaximum Length:1Default Value:YIndicates if the lookup code is enabled or not. -
EndDateActive: string
(date)
Title:
End DateThe date on which the lookup code is no longer active. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date on which the record was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the record. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login credentials of the user who last updated the record. -
LookupCode: string
Title:
Lookup CodeMaximum Length:30The unique code that identifies the lookup. -
Meaning: string
Title:
MeaningMaximum Length:80The meaning of the lookup code. -
SetCode: string
Title:
Set CodeRead Only:trueMaximum Length:30The set code that identifies the lookup code. -
SetId: integer
(int64)
The unique identifier of the set.
-
StartDateActive: string
(date)
Title:
Start DateThe date on which the lookup code becomes active. -
Tag: string
Title:
TagMaximum Length:150An optional tag used to filter the lookup codes.
Nested Schema : lookupsDFF
Type:
Show Source
array-
Array of:
object Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context" }
Nested Schema : translations
Type:
Show Source
array-
Array of:
object Set Enabled Lookup Codes Translations VO
Title:
Set Enabled Lookup Codes Translations VO
Nested Schema : Discriminator: __FLEX_Context
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30 -
__FLEX_Context_DisplayValue: string
Title:
Context Segment -
loc: string
Title:
locMaximum Length:150 -
LookupCode: string
Title:
Lookup CodeMaximum Length:30 -
LookupType: string
Title:
Lookup TypeMaximum Length:30 -
sd1: string
Title:
sd1Maximum Length:150 -
SetId: integer
(int64)
Title:
Reference Data Set -
ViewApplicationId: integer
(int64)
Nested Schema : Set Enabled Lookup Codes Translations VO
Type:
objectTitle:
Show Source
Set Enabled Lookup Codes Translations VO-
CreatedBy: string
Read Only:
trueMaximum Length:64 -
CreationDate: string
(date-time)
Read Only:
true -
Description: string
Maximum Length:
240 -
Language: string
Maximum Length:
30 -
LastUpdateDate: string
(date-time)
Read Only:
true -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64 -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32 -
Meaning: string
Maximum Length:
80 -
SourceLang: string
Maximum Length:
4
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- 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 : setEnabledLookups-lookupCodes-item-response
Match All
Show Source
-
object
ItemProperties
-
object
Set Enabled Lookup Codes VO
Title:
Set Enabled Lookup Codes VO -
object
setEnabledLookups-lookupCodes-item-response-allOf[2]
Nested Schema : ItemProperties
Type:
Show Source
object-
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Set Enabled Lookup Codes VO
Type:
objectTitle:
Show Source
Set Enabled Lookup Codes VO-
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Read Only:
trueThe date on which the record was created. -
Description: string
Title:
DescriptionMaximum Length:240The description of the lookup. -
DisplaySequence: integer
(int64)
Title:
Display SequenceThe sequence in which the lookup code should be displayed. -
EnabledFlag: string
Title:
EnabledMaximum Length:1Default Value:YIndicates if the lookup code is enabled or not. -
EndDateActive: string
(date)
Title:
End DateThe date on which the lookup code is no longer active. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date on which the record was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the record. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login credentials of the user who last updated the record. -
LookupCode: string
Title:
Lookup CodeMaximum Length:30The unique code that identifies the lookup. -
Meaning: string
Title:
MeaningMaximum Length:80The meaning of the lookup code. -
SetCode: string
Title:
Set CodeRead Only:trueMaximum Length:30The set code that identifies the lookup code. -
SetId: integer
(int64)
The unique identifier of the set.
-
StartDateActive: string
(date)
Title:
Start DateThe date on which the lookup code becomes active. -
Tag: string
Title:
TagMaximum Length:150An optional tag used to filter the lookup codes.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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
The value of this attribute changes with each update to the resource instance. The value of the changeIndicator attribute is same as the entity tag (ETag) in the HTTP header.
Nested Schema : setEnabledLookups-lookupCodes-lookupsDFF-item-response
Match All
Show Source
-
object
ItemProperties
-
object
Discriminator: __FLEX_Context
Discriminator:
{ "propertyName":"__FLEX_Context" }
Nested Schema : Discriminator: __FLEX_Context
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30 -
__FLEX_Context_DisplayValue: string
Title:
Context Segment -
loc: string
Title:
locMaximum Length:150 -
LookupCode: string
Title:
Lookup CodeMaximum Length:30 -
LookupType: string
Title:
Lookup TypeMaximum Length:30 -
sd1: string
Title:
sd1Maximum Length:150 -
SetId: integer
(int64)
Title:
Reference Data Set -
ViewApplicationId: integer
(int64)
Nested Schema : setEnabledLookups-lookupCodes-translations-item-response
Match All
Show Source
-
object
ItemProperties
-
object
Set Enabled Lookup Codes Translations VO
Title:
Set Enabled Lookup Codes Translations VO
Nested Schema : Set Enabled Lookup Codes Translations VO
Type:
objectTitle:
Show Source
Set Enabled Lookup Codes Translations VO-
CreatedBy: string
Read Only:
trueMaximum Length:64 -
CreationDate: string
(date-time)
Read Only:
true -
Description: string
Maximum Length:
240 -
Language: string
Maximum Length:
30 -
LastUpdateDate: string
(date-time)
Read Only:
true -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64 -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32 -
Meaning: string
Maximum Length:
80 -
SourceLang: string
Maximum Length:
4