Jump to

• Request
• Response

Update a lookup type

patch

/fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes/{publicSectorLookupTypesUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorLookupTypesUniqID: integer
  This is the hash key of the attributes which make up the composite key--- LookupType and ViewApplicationId ---for the Lookup Types resource and used to uniquely identify an instance of Lookup Types. The client should not generate the hash key value. Instead, the client should query on the Lookup Types collection resource with a filter on the primary key values in order to navigate to a specific instance of Lookup Types.
  
  For example: publicSectorLookupTypes?q=LookupType=<value1>;ViewApplicationId=<value2>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorLookupTypes-item

Type: object

Show Source

• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the lookup type.
• CreationDate(optional): string(date-time)
  The date and time on which the lookup type was created.
• CustomizationLevel(optional): string
  Title: Configuration Level

  Maximum Length: 1

  The configuration level code such as system level or user level.
• Description(optional): string
  Title: Description

  Maximum Length: 240

  The description of the lookup type code.
• LastUpdateDate(optional): string(date-time)
  The date on which the lookup type was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the lookup type.
• links(optional): array Items
  Title: Items

  Link Relations
• LookupType(optional): string
  Title: Lookup Type

  Maximum Length: 30

  The lookup type code.
• Meaning(optional): string
  Title: Meaning

  Maximum Length: 80

  The meaning of the lookup type code.
• ModuleId(optional): string
  Title: Module

  Maximum Length: 32

  The unique module identifier associated with a logical business area such as billing or payment.
• PscLookupValue(optional): array Lookup Values
  Title: Lookup Values

  The lookup type resource is used to view, create, delete or modify lookup types. The object stores lookup type information such as lookup type and configuration level.
• ReferenceGroupName(optional): string
  Title: Reference Group Name

  Maximum Length: 30

  The reference group name.
• UserModuleName(optional): string
  Title: User Module Name

  Maximum Length: 512

  The module name displayed to the user.
• ViewApplicationId(optional): integer(int64)
  Title: Application

  The application ID associated with product like permits.

{
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the lookup type."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time on which the lookup type was created."
        },
        "CustomizationLevel":{
            "maxLength":1,
            "type":"string",
            "description":"The configuration level code such as system level or user level.",
            "title":"Configuration Level"
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"The description of the lookup type code.",
            "title":"Description"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the lookup type was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the lookup type."
        },
        "LookupType":{
            "maxLength":30,
            "type":"string",
            "description":"The lookup type code.",
            "title":"Lookup Type"
        },
        "Meaning":{
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the lookup type code.",
            "title":"Meaning"
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"The unique module identifier associated with a logical business area such as billing or payment.",
            "title":"Module"
        },
        "PscLookupValue":{
            "items":{
                "$ref":"#/definitions/publicSectorLookupTypes-PscLookupValue-item"
            },
            "type":"array",
            "description":"The lookup type resource is used to view, create, delete or modify lookup types. The object stores lookup type information such as  lookup type and configuration level.",
            "title":"Lookup Values"
        },
        "ReferenceGroupName":{
            "maxLength":30,
            "type":"string",
            "description":"The reference group name.",
            "title":"Reference Group Name"
        },
        "UserModuleName":{
            "maxLength":512,
            "type":"string",
            "description":"The module name displayed to the user.",
            "title":"User Module Name"
        },
        "ViewApplicationId":{
            "format":"int64",
            "type":"integer",
            "description":"The application ID associated with product like permits.",
            "title":"Application"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : Lookup Values

Type: array

Title: Lookup Values

The lookup type resource is used to view, create, delete or modify lookup types. The object stores lookup type information such as lookup type and configuration level.

Show Source

• Array of: object publicSectorLookupTypes-PscLookupValue-item
  Discriminator: ViewApplicationId

{
    "items":{
        "$ref":"#/definitions/publicSectorLookupTypes-PscLookupValue-item"
    },
    "type":"array",
    "description":"The lookup type resource is used to view, create, delete or modify lookup types. The object stores lookup type information such as  lookup type and configuration level.",
    "title":"Lookup Values"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorLookupTypes-PscLookupValue-item

Type: object

Discriminator: ViewApplicationId

Show Source

• AttributeCategory(optional): string
  Title: Attribute Category

  Maximum Length: 30

  The attribute category code.
• CreatedBy(optional): string
  Maximum Length: 64

  The date and time on which the lookup value was created.
• CreationDate(optional): string(date-time)
  The user who created the lookup value.
• Description(optional): string
  Title: Description

  Maximum Length: 240

  The description of the lookup value code.
• DisplaySequence(optional): integer(int64)
  Title: Display Sequence

  The order in which lookup types are displayed.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether a lookup value is enabled. The default value is true.
• EndDateActive(optional): string(date)
  Title: End Date

  The date on which the lookup value code becomes inactive.
• LastUpdateDate(optional): string(date-time)
  The date on which the lookup value was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the lookup value.
• links(optional): array Items
  Title: Items

  Link Relations
• LookupCode(optional): string
  Title: Lookup Code

  Maximum Length: 30

  The lookup value code.
• LookupType(optional): string
  Title: Lookup Type

  Maximum Length: 30

  The lookup type code.
• Meaning(optional): string
  Title: Meaning

  Maximum Length: 80

  The meaning of the lookup value code.
• SetId(optional): integer(int64)
  The unique identifier for a set of lookups.
• StartDateActive(optional): string(date)
  Title: Start Date

  The date on which the lookup value code becomes active.
• Tag(optional): string
  Title: Tag

  Maximum Length: 150

  The tag of the lookup value code. Tags on lookup codes enable you to add a label to your lookup codes. A tag can be used to categorize lookups based on facilitating searches or guiding how a lookup should be used.
• ViewApplicationId: integer(int64)
  Title: Application

  The unique application identifier associated with a product.

{
    "properties":{
        "AttributeCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The attribute category code.",
            "title":"Attribute Category"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The date and time on which the lookup value was created."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The user who created the lookup value."
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"The description of the lookup value code.",
            "title":"Description"
        },
        "DisplaySequence":{
            "format":"int64",
            "type":"integer",
            "description":"The order in which lookup types are displayed.",
            "title":"Display Sequence"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether a lookup value is enabled. The default value is true.",
            "title":"Enabled"
        },
        "EndDateActive":{
            "format":"date",
            "type":"string",
            "description":"The date on which the lookup value code becomes inactive.",
            "title":"End Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the lookup value was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the lookup value."
        },
        "LookupCode":{
            "maxLength":30,
            "type":"string",
            "description":"The lookup value code.",
            "title":"Lookup Code"
        },
        "LookupType":{
            "maxLength":30,
            "type":"string",
            "description":"The lookup type code.",
            "title":"Lookup Type"
        },
        "Meaning":{
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the lookup value code.",
            "title":"Meaning"
        },
        "SetId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a set of lookups."
        },
        "StartDateActive":{
            "format":"date",
            "type":"string",
            "description":"The date on which the lookup value code becomes active.",
            "title":"Start Date"
        },
        "Tag":{
            "maxLength":150,
            "type":"string",
            "description":"The tag of the lookup value code. Tags on lookup codes enable you to add a label to your lookup codes. A tag can be used to categorize lookups based on facilitating searches or guiding how a lookup should be used.",
            "title":"Tag"
        },
        "ViewApplicationId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique application identifier associated with a product.",
            "title":"Application"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "required":[
        "ViewApplicationId"
    ],
    "discriminator":"ViewApplicationId",
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorLookupTypes-item

Type: object

Show Source

• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the lookup type.
• CreationDate(optional): string(date-time)
  The date and time on which the lookup type was created.
• CustomizationLevel(optional): string
  Title: Configuration Level

  Maximum Length: 1

  The configuration level code such as system level or user level.
• Description(optional): string
  Title: Description

  Maximum Length: 240

  The description of the lookup type code.
• LastUpdateDate(optional): string(date-time)
  The date on which the lookup type was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the lookup type.
• links(optional): array Items
  Title: Items

  Link Relations
• LookupType(optional): string
  Title: Lookup Type

  Maximum Length: 30

  The lookup type code.
• Meaning(optional): string
  Title: Meaning

  Maximum Length: 80

  The meaning of the lookup type code.
• ModuleId(optional): string
  Title: Module

  Maximum Length: 32

  The unique module identifier associated with a logical business area such as billing or payment.
• PscLookupValue(optional): array Lookup Values
  Title: Lookup Values

  The lookup type resource is used to view, create, delete or modify lookup types. The object stores lookup type information such as lookup type and configuration level.
• ReferenceGroupName(optional): string
  Title: Reference Group Name

  Maximum Length: 30

  The reference group name.
• UserModuleName(optional): string
  Title: User Module Name

  Maximum Length: 512

  The module name displayed to the user.
• ViewApplicationId(optional): integer(int64)
  Title: Application

  The application ID associated with product like permits.

{
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the lookup type."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time on which the lookup type was created."
        },
        "CustomizationLevel":{
            "maxLength":1,
            "type":"string",
            "description":"The configuration level code such as system level or user level.",
            "title":"Configuration Level"
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"The description of the lookup type code.",
            "title":"Description"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the lookup type was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the lookup type."
        },
        "LookupType":{
            "maxLength":30,
            "type":"string",
            "description":"The lookup type code.",
            "title":"Lookup Type"
        },
        "Meaning":{
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the lookup type code.",
            "title":"Meaning"
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"The unique module identifier associated with a logical business area such as billing or payment.",
            "title":"Module"
        },
        "PscLookupValue":{
            "items":{
                "$ref":"#/definitions/publicSectorLookupTypes-PscLookupValue-item"
            },
            "type":"array",
            "description":"The lookup type resource is used to view, create, delete or modify lookup types. The object stores lookup type information such as  lookup type and configuration level.",
            "title":"Lookup Values"
        },
        "ReferenceGroupName":{
            "maxLength":30,
            "type":"string",
            "description":"The reference group name.",
            "title":"Reference Group Name"
        },
        "UserModuleName":{
            "maxLength":512,
            "type":"string",
            "description":"The module name displayed to the user.",
            "title":"User Module Name"
        },
        "ViewApplicationId":{
            "format":"int64",
            "type":"integer",
            "description":"The application ID associated with product like permits.",
            "title":"Application"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : Lookup Values

Type: array

Title: Lookup Values

The lookup type resource is used to view, create, delete or modify lookup types. The object stores lookup type information such as lookup type and configuration level.

Show Source

• Array of: object publicSectorLookupTypes-PscLookupValue-item
  Discriminator: ViewApplicationId

{
    "items":{
        "$ref":"#/definitions/publicSectorLookupTypes-PscLookupValue-item"
    },
    "type":"array",
    "description":"The lookup type resource is used to view, create, delete or modify lookup types. The object stores lookup type information such as  lookup type and configuration level.",
    "title":"Lookup Values"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Nested Schema : publicSectorLookupTypes-PscLookupValue-item

Type: object

Discriminator: ViewApplicationId

Show Source

• AttributeCategory(optional): string
  Title: Attribute Category

  Maximum Length: 30

  The attribute category code.
• CreatedBy(optional): string
  Maximum Length: 64

  The date and time on which the lookup value was created.
• CreationDate(optional): string(date-time)
  The user who created the lookup value.
• Description(optional): string
  Title: Description

  Maximum Length: 240

  The description of the lookup value code.
• DisplaySequence(optional): integer(int64)
  Title: Display Sequence

  The order in which lookup types are displayed.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether a lookup value is enabled. The default value is true.
• EndDateActive(optional): string(date)
  Title: End Date

  The date on which the lookup value code becomes inactive.
• LastUpdateDate(optional): string(date-time)
  The date on which the lookup value was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the lookup value.
• links(optional): array Items
  Title: Items

  Link Relations
• LookupCode(optional): string
  Title: Lookup Code

  Maximum Length: 30

  The lookup value code.
• LookupType(optional): string
  Title: Lookup Type

  Maximum Length: 30

  The lookup type code.
• Meaning(optional): string
  Title: Meaning

  Maximum Length: 80

  The meaning of the lookup value code.
• SetId(optional): integer(int64)
  The unique identifier for a set of lookups.
• StartDateActive(optional): string(date)
  Title: Start Date

  The date on which the lookup value code becomes active.
• Tag(optional): string
  Title: Tag

  Maximum Length: 150

  The tag of the lookup value code. Tags on lookup codes enable you to add a label to your lookup codes. A tag can be used to categorize lookups based on facilitating searches or guiding how a lookup should be used.
• ViewApplicationId: integer(int64)
  Title: Application

  The unique application identifier associated with a product.

{
    "properties":{
        "AttributeCategory":{
            "maxLength":30,
            "type":"string",
            "description":"The attribute category code.",
            "title":"Attribute Category"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The date and time on which the lookup value was created."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The user who created the lookup value."
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"The description of the lookup value code.",
            "title":"Description"
        },
        "DisplaySequence":{
            "format":"int64",
            "type":"integer",
            "description":"The order in which lookup types are displayed.",
            "title":"Display Sequence"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether a lookup value is enabled. The default value is true.",
            "title":"Enabled"
        },
        "EndDateActive":{
            "format":"date",
            "type":"string",
            "description":"The date on which the lookup value code becomes inactive.",
            "title":"End Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the lookup value was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the lookup value."
        },
        "LookupCode":{
            "maxLength":30,
            "type":"string",
            "description":"The lookup value code.",
            "title":"Lookup Code"
        },
        "LookupType":{
            "maxLength":30,
            "type":"string",
            "description":"The lookup type code.",
            "title":"Lookup Type"
        },
        "Meaning":{
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the lookup value code.",
            "title":"Meaning"
        },
        "SetId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a set of lookups."
        },
        "StartDateActive":{
            "format":"date",
            "type":"string",
            "description":"The date on which the lookup value code becomes active.",
            "title":"Start Date"
        },
        "Tag":{
            "maxLength":150,
            "type":"string",
            "description":"The tag of the lookup value code. Tags on lookup codes enable you to add a label to your lookup codes. A tag can be used to categorize lookups based on facilitating searches or guiding how a lookup should be used.",
            "title":"Tag"
        },
        "ViewApplicationId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique application identifier associated with a product.",
            "title":"Application"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "required":[
        "ViewApplicationId"
    ],
    "discriminator":"ViewApplicationId",
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Back to Top