Jump to

• Request
• Response

Create a lookup code

post

/fscmRestApi/resources/11.13.18.05/standardLookups/{standardLookups_Id}/child/lookupCodes

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.
• 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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

{
    "required":[
        "Meaning"
    ],
    "type":"object",
    "properties":{
        "lookupsDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/standardLookups-lookupCodes-lookupsDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date on which the lookup code becomes active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date on which the lookup code is no longer active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the lookup.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The sequence in which the lookup code should be displayed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "translations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/standardLookups-lookupCodes-translations-item-post-request"
            }
        },
        "Tag":{
            "title":"Tag",
            "maxLength":150,
            "type":"string",
            "description":"An optional tag used to filter the lookup codes.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the lookup code is enabled or not.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "Meaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the lookup code.",
            "nullable":false,
            "x-queryable":true
        },
        "LookupCode":{
            "title":"Lookup Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code that identifies the lookup.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : lookupsDFF

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/standardLookups-lookupCodes-lookupsDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : translations

Type: array

Show Source

• Array of: object standardLookups-lookupCodes-translations-item-post-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/standardLookups-lookupCodes-translations-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• __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)

{
    "type":"object",
    "properties":{
        "ViewApplicationId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "LookupType":{
            "title":"Lookup Type",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "SetId":{
            "title":"Reference Data Set",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "LookupCode":{
            "title":"Lookup Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : standardLookups-lookupCodes-translations-item-post-request

Type: object

Show Source

• Description: string
  Maximum Length: 240
• Language: string
  Maximum Length: 30
• Meaning: string
  Maximum Length: 80
• SourceLang: string
  Maximum Length: 4

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "Meaning":{
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : standardLookups-lookupCodes-item-response

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "lookupsDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/standardLookups-lookupCodes-lookupsDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "CreationDate":{
            "type":"string",
            "description":"The date on which the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the lookup.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Display Sequence",
            "type":"integer",
            "description":"The sequence in which the lookup code should be displayed.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LookupCode":{
            "title":"Lookup Code",
            "maxLength":30,
            "type":"string",
            "description":"The unique code that identifies the lookup.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"Start Date",
            "type":"string",
            "description":"The date on which the lookup code becomes active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"End Date",
            "type":"string",
            "description":"The date on which the lookup code is no longer active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "translations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/standardLookups-lookupCodes-translations-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Tag":{
            "title":"Tag",
            "maxLength":150,
            "type":"string",
            "description":"An optional tag used to filter the lookup codes.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the lookup code is enabled or not.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "Meaning":{
            "title":"Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the lookup code.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date on which the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login credentials of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : lookupsDFF

Type: array

Show Source

• Array of: object standardLookups-lookupCodes-lookupsDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/standardLookups-lookupCodes-lookupsDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : translations

Type: array

Show Source

• Array of: object standardLookups-lookupCodes-translations-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/standardLookups-lookupCodes-translations-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : standardLookups-lookupCodes-lookupsDFF-item-response

Type: object

Show Source

• __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)

{
    "type":"object",
    "properties":{
        "ViewApplicationId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "LookupType":{
            "title":"Lookup Type",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SetId":{
            "title":"Reference Data Set",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "LookupCode":{
            "title":"Lookup Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"Context Segment",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : standardLookups-lookupCodes-translations-item-response

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Meaning":{
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

lookupsDFF

Operation: /fscmRestApi/resources/11.13.18.05/standardLookups/{standardLookups_Id}/child/lookupCodes/{standardLookups_lookupCodes_Id}/child/lookupsDFF

Parameters:

• standardLookups_Id: $request.path.standardLookups_Id
• standardLookups_lookupCodes_Id: $request.path.standardLookups_lookupCodes_Id

translations

Operation: /fscmRestApi/resources/11.13.18.05/standardLookups/{standardLookups_Id}/child/lookupCodes/{standardLookups_lookupCodes_Id}/child/translations

Parameters:

• standardLookups_Id: $request.path.standardLookups_Id
• standardLookups_lookupCodes_Id: $request.path.standardLookups_lookupCodes_Id

Back to Top