Create a common lookup
post
servername/fscmRestApi/resources/11.13.18.05/commonLookups
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: 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 Common Lookup Types VO Title:
Common Lookup Types VO - object type
Nested Schema : Common Lookup Types VO
Type:
objectTitle:
Show Source Common Lookup Types VO- CreatedBy: string Read Only:
trueMaximum Length:64The user who created the record. - CreationDate: string (date-time) Read Only:
trueThe date when the record was created. - CustomizationLevel: string Title:
Lookup Configuration LevelMaximum Length:1Default Value:UA code that indicates the CustomizationLevel. - Description: string Title:
DescriptionMaximum Length:240The description of the lookup. - LastUpdateDate: string (date-time) Read Only:
trueThe date when 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. - LookupType: string Title:
Lookup TypeMaximum Length:30The lookup type that identifies the lookup. - Meaning: string Title:
MeaningMaximum Length:80The meaning of the common lookup. - ModuleId: string Title:
ModuleMaximum Length:32The unique identifier of the module with which the lookup is associated. - RestAccessSecured: string Title:
REST Access SecuredMaximum Length:8The level of security set on the associated REST service.
Nested Schema : translations
Type:
Show Source array- Array of: object Common Lookup Types Translations VO Title:
Common Lookup Types Translations VO
Nested Schema : commonLookups-lookupCodes-item-request
Match All
Show Source - object Common Lookup Codes VO Title:
Common Lookup Codes VO - object commonLookups-lookupCodes-item-request-allOf[1]
Nested Schema : Common Lookup Codes VO
Type:
objectTitle:
Show Source Common Lookup Codes VO- CreatedBy: string Read Only:
trueMaximum Length:64The user who created the record. - CreationDate: string (date-time) Read Only:
trueThe date when the record was created. - Description: string Title:
DescriptionMaximum Length:240The description of the lookup code. - 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. - 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 Common Lookup Codes Translations VO Title:
Common 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 : Common Lookup Codes Translations VO
Type:
objectTitle:
Show Source Common 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
Nested Schema : Common Lookup Types Translations VO
Type:
objectTitle:
Show Source Common Lookup Types 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:
4 - LastUpdateDate: string (date-time) Read Only:
true - LastUpdatedBy: string Read Only:
trueMaximum Length:64 - LastUpdateLogin: string Read Only:
trueMaximum Length:32 - Meaning: string Title:
MeaningMaximum Length:80 - SourceLang: string Maximum Length:
4
Root Schema : schema
Match All
Show Source - object Common Lookup Types VO Title:
Common Lookup Types VO - object type
Nested Schema : Common Lookup Types VO
Type:
objectTitle:
Show Source Common Lookup Types VO- CreatedBy: string Read Only:
trueMaximum Length:64The user who created the record. - CreationDate: string (date-time) Read Only:
trueThe date when the record was created. - CustomizationLevel: string Title:
Lookup Configuration LevelMaximum Length:1Default Value:UA code that indicates the CustomizationLevel. - Description: string Title:
DescriptionMaximum Length:240The description of the lookup. - LastUpdateDate: string (date-time) Read Only:
trueThe date when 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. - LookupType: string Title:
Lookup TypeMaximum Length:30The lookup type that identifies the lookup. - Meaning: string Title:
MeaningMaximum Length:80The meaning of the common lookup. - ModuleId: string Title:
ModuleMaximum Length:32The unique identifier of the module with which the lookup is associated. - RestAccessSecured: string Title:
REST Access SecuredMaximum Length:8The level of security set on the associated REST service.
Nested Schema : translations
Type:
Show Source array- Array of: object Common Lookup Types Translations VO Title:
Common Lookup Types Translations VO
Nested Schema : commonLookups-lookupCodes-item-request
Match All
Show Source - object Common Lookup Codes VO Title:
Common Lookup Codes VO - object commonLookups-lookupCodes-item-request-allOf[1]
Nested Schema : Common Lookup Codes VO
Type:
objectTitle:
Show Source Common Lookup Codes VO- CreatedBy: string Read Only:
trueMaximum Length:64The user who created the record. - CreationDate: string (date-time) Read Only:
trueThe date when the record was created. - Description: string Title:
DescriptionMaximum Length:240The description of the lookup code. - 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. - 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 Common Lookup Codes Translations VO Title:
Common 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 : Common Lookup Codes Translations VO
Type:
objectTitle:
Show Source Common 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
Nested Schema : Common Lookup Types Translations VO
Type:
objectTitle:
Show Source Common Lookup Types 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:
4 - LastUpdateDate: string (date-time) Read Only:
true - LastUpdatedBy: string Read Only:
trueMaximum Length:64 - LastUpdateLogin: string Read Only:
trueMaximum Length:32 - Meaning: string Title:
MeaningMaximum 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 : commonLookups-item-response
Match All
Show Source - object ItemProperties
- object Common Lookup Types VO Title:
Common Lookup Types VO - object commonLookups-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 : Common Lookup Types VO
Type:
objectTitle:
Show Source Common Lookup Types VO- CreatedBy: string Read Only:
trueMaximum Length:64The user who created the record. - CreationDate: string (date-time) Read Only:
trueThe date when the record was created. - CustomizationLevel: string Title:
Lookup Configuration LevelMaximum Length:1Default Value:UA code that indicates the CustomizationLevel. - Description: string Title:
DescriptionMaximum Length:240The description of the lookup. - LastUpdateDate: string (date-time) Read Only:
trueThe date when 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. - LookupType: string Title:
Lookup TypeMaximum Length:30The lookup type that identifies the lookup. - Meaning: string Title:
MeaningMaximum Length:80The meaning of the common lookup. - ModuleId: string Title:
ModuleMaximum Length:32The unique identifier of the module with which the lookup is associated. - RestAccessSecured: string Title:
REST Access SecuredMaximum Length:8The level of security set on the associated REST service.
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 Change indicator or the ETag value of the resource instance.
Nested Schema : commonLookups-lookupCodes-item-response
Match All
Show Source - object ItemProperties
- object Common Lookup Codes VO Title:
Common Lookup Codes VO - object commonLookups-lookupCodes-item-response-allOf[2]
Nested Schema : Common Lookup Codes VO
Type:
objectTitle:
Show Source Common Lookup Codes VO- CreatedBy: string Read Only:
trueMaximum Length:64The user who created the record. - CreationDate: string (date-time) Read Only:
trueThe date when the record was created. - Description: string Title:
DescriptionMaximum Length:240The description of the lookup code. - 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. - 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 : commonLookups-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 : commonLookups-lookupCodes-translations-item-response
Match All
Show Source - object ItemProperties
- object Common Lookup Codes Translations VO Title:
Common Lookup Codes Translations VO
Nested Schema : Common Lookup Codes Translations VO
Type:
objectTitle:
Show Source Common 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
Nested Schema : commonLookups-translations-item-response
Match All
Show Source - object ItemProperties
- object Common Lookup Types Translations VO Title:
Common Lookup Types Translations VO
Nested Schema : Common Lookup Types Translations VO
Type:
objectTitle:
Show Source Common Lookup Types 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:
4 - LastUpdateDate: string (date-time) Read Only:
true - LastUpdatedBy: string Read Only:
trueMaximum Length:64 - LastUpdateLogin: string Read Only:
trueMaximum Length:32 - Meaning: string Title:
MeaningMaximum Length:80 - SourceLang: string Maximum Length:
4