Update a standard lookup
patch
/fscmRestApi/resources/11.13.18.05/standardLookups/{standardLookups_Id}
Request
Path Parameters
-
standardLookups_Id(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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
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. -
lookupCodes: array
Standard Lookup Codes
Title:
Standard Lookup CodesThe 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. -
Meaning: string
Title:
MeaningMaximum Length:80The meaning of the lookup. -
ModuleId: string
Title:
ModuleMaximum Length:32The unique identifier of the module. -
RestAccessSecured: string
Title:
REST Access SecuredMaximum Length:8The level of security set on the associated REST service. -
translations: array
translations
Nested Schema : Standard Lookup Codes
Type:
arrayTitle:
Standard Lookup CodesThe 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 : schema
Type:
Show Source
object-
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. -
lookupsDFF: array
lookupsDFF
-
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. -
translations: array
translations
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:30Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
LookupCode: string
Title:
Lookup CodeMaximum Length:30 -
LookupType: string
Title:
Lookup TypeMaximum Length:30 -
SetId: integer
(int64)
Title:
Reference Data Set -
ViewApplicationId: integer
(int64)
Nested Schema : standardLookups-lookupCodes-translations-item-patch-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-patch-request
Type:
Show Source
object-
Description: string
Maximum Length:
240 -
Language: string
Maximum Length:
4 -
Meaning: string
Title:
MeaningMaximum 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:
trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Read Only:
trueThe date on which 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 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. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
lookupCodes: array
Standard Lookup Codes
Title:
Standard Lookup CodesThe 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 TypeMaximum Length:30The lookup type that identifies the lookup. -
Meaning: string
Title:
MeaningMaximum Length:80The meaning of the lookup. -
ModuleId: string
Title:
ModuleMaximum Length:32The unique identifier of the module. -
RestAccessSecured: string
Title:
REST Access SecuredMaximum Length:8The level of security set on the associated REST service. -
translations: array
translations
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Standard Lookup Codes
Type:
arrayTitle:
Standard Lookup CodesThe 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 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 : standardLookups-lookupCodes-item-response
Type:
Show Source
object-
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. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LookupCode: string
Title:
Lookup CodeMaximum Length:30The unique code that identifies the lookup. -
lookupsDFF: array
lookupsDFF
-
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. -
translations: array
translations
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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 SegmentMaximum Length:30Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LookupCode: string
Title:
Lookup CodeMaximum Length:30 -
LookupType: string
Title:
Lookup TypeMaximum Length:30 -
SetId: integer
(int64)
Title:
Reference Data Set -
ViewApplicationId: integer
(int64)
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : standardLookups-lookupCodes-translations-item-response
Type:
Show Source
object-
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 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Meaning: string
Maximum Length:
80 -
SourceLang: string
Maximum Length:
4
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : standardLookups-translations-item-response
Type:
Show Source
object-
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 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Meaning: string
Title:
MeaningMaximum Length:80 -
SourceLang: string
Maximum Length:
4
Nested Schema : Links
Type:
arrayTitle:
LinksThe 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: