Create a standard lookup
post
/fscmRestApi/resources/11.13.18.05/standardLookups
Request
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
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
CustomizationLevel: string
Title:
Lookup Configuration Level
Maximum Length:1
Default Value:U
A code that indicates the CustomizationLevel. -
Description: string
Title:
Description
Maximum Length:240
The description of the lookup. -
lookupCodes: array
Standard Lookup Codes
Title:
Standard Lookup Codes
The lookup codes resource is used to view, create, update, and delete standard lookup codes, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that enable reference data sharing. -
LookupType(required): string
Title:
Lookup Type
Maximum Length:30
The lookup type that identifies the lookup. -
Meaning(required): string
Title:
Meaning
Maximum Length:80
The meaning of the lookup. -
ModuleId(required): string
Title:
Module
Maximum Length:32
The unique identifier of the module. -
RestAccessSecured: string
Title:
REST Access Secured
Maximum Length:8
The level of security set on the associated REST service. -
translations: array
translations
Nested Schema : Standard Lookup Codes
Type:
array
Title:
Standard Lookup Codes
The lookup codes resource is used to view, create, update, and delete standard lookup codes, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that enable reference data sharing.
Show Source
Nested Schema : standardLookups-lookupCodes-item-post-request
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:240
The description of the lookup. -
DisplaySequence: integer
(int64)
Title:
Display Sequence
The sequence in which the lookup code should be displayed. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Default Value:Y
Indicates if the lookup code is enabled or not. -
EndDateActive: string
(date)
Title:
End Date
The date on which the lookup code is no longer active. -
LookupCode: string
Title:
Lookup Code
Maximum Length:30
The unique code that identifies the lookup. -
lookupsDFF: array
lookupsDFF
-
Meaning(required): string
Title:
Meaning
Maximum Length:80
The meaning of the lookup code. -
StartDateActive: string
(date)
Title:
Start Date
The date on which the lookup code becomes active. -
Tag: string
Title:
Tag
Maximum Length:150
An optional tag used to filter the lookup codes. -
translations: array
translations
Nested Schema : standardLookups-lookupCodes-lookupsDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Context Segment -
LookupCode: string
Title:
Lookup Code
Maximum Length:30
-
LookupType: string
Title:
Lookup Type
Maximum Length:30
-
SetId: integer
(int64)
Title:
Reference Data Set
-
ViewApplicationId: integer
(int64)
Nested Schema : standardLookups-lookupCodes-translations-item-post-request
Type:
Show Source
object
-
Description: string
Maximum Length:
240
-
Language: string
Maximum Length:
30
-
Meaning: string
Maximum Length:
80
-
SourceLang: string
Maximum Length:
4
Nested Schema : standardLookups-translations-item-post-request
Type:
Show Source
object
-
Description: string
Maximum Length:
240
-
Language: string
Maximum Length:
4
-
Meaning: string
Title:
Meaning
Maximum Length:80
-
SourceLang: string
Maximum Length:
4
Response
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 : standardLookups-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date on which the record was created. -
CustomizationLevel: string
Title:
Lookup Configuration Level
Maximum Length:1
Default Value:U
A code that indicates the CustomizationLevel. -
Description: string
Title:
Description
Maximum Length:240
The description of the lookup. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date on which the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login credentials of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
lookupCodes: array
Standard Lookup Codes
Title:
Standard Lookup Codes
The lookup codes resource is used to view, create, update, and delete standard lookup codes, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that enable reference data sharing. -
LookupType: string
Title:
Lookup Type
Maximum Length:30
The lookup type that identifies the lookup. -
Meaning: string
Title:
Meaning
Maximum Length:80
The meaning of the lookup. -
ModuleId: string
Title:
Module
Maximum Length:32
The unique identifier of the module. -
RestAccessSecured: string
Title:
REST Access Secured
Maximum Length:8
The level of security set on the associated REST service. -
translations: array
translations
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Standard Lookup Codes
Type:
array
Title:
Standard Lookup Codes
The lookup codes resource is used to view, create, update, and delete standard lookup codes, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that enable reference data sharing.
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 : standardLookups-lookupCodes-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date on which the record was created. -
Description: string
Title:
Description
Maximum Length:240
The description of the lookup. -
DisplaySequence: integer
(int64)
Title:
Display Sequence
The sequence in which the lookup code should be displayed. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Default Value:Y
Indicates if the lookup code is enabled or not. -
EndDateActive: string
(date)
Title:
End Date
The date on which the lookup code is no longer active. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date on which the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login credentials of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupCode: string
Title:
Lookup Code
Maximum Length:30
The unique code that identifies the lookup. -
lookupsDFF: array
lookupsDFF
-
Meaning: string
Title:
Meaning
Maximum Length:80
The meaning of the lookup code. -
StartDateActive: string
(date)
Title:
Start Date
The date on which the lookup code becomes active. -
Tag: string
Title:
Tag
Maximum Length:150
An optional tag used to filter the lookup codes. -
translations: array
translations
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : standardLookups-lookupCodes-lookupsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Context Segment -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupCode: string
Title:
Lookup Code
Maximum Length:30
-
LookupType: string
Title:
Lookup Type
Maximum Length:30
-
SetId: integer
(int64)
Title:
Reference Data Set
-
ViewApplicationId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : standardLookups-lookupCodes-translations-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum 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:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Meaning: string
Maximum Length:
80
-
SourceLang: string
Maximum Length:
4
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : standardLookups-translations-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum 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:
true
Maximum Length:64
-
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Meaning: string
Title:
Meaning
Maximum Length:80
-
SourceLang: string
Maximum Length:
4
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- lookupCodes
-
Operation: /fscmRestApi/resources/11.13.18.05/standardLookups/{standardLookups_Id}/child/lookupCodesParameters:
- standardLookups_Id:
$request.path.standardLookups_Id
- standardLookups_Id:
- translations
-
Operation: /fscmRestApi/resources/11.13.18.05/standardLookups/{standardLookups_Id}/child/translationsParameters:
- standardLookups_Id:
$request.path.standardLookups_Id
- standardLookups_Id: