Jump to

• Request
• Response

Update an enumeration value

patch

/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations/{EnumName}/child/EnumValueService/{EnumValueServiceUniqID}

Request

Supported Media Types

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

Path Parameters

• EnumName: string
  The name of the enumeration.
• EnumValueServiceUniqID: integer
  This is the hash key of the attributes which make up the composite key--- EnumName and EnumValue ---for the Enumeration Values resource and used to uniquely identify an instance of Enumeration Values. The client should not generate the hash key value. Instead, the client should query on the Enumeration Values collection resource with a filter on the primary key values in order to navigate to a specific instance of Enumeration Values.
  
  For example: EnumValueService?q=EnumName=<value1>;EnumValue=<value2>

Body ()

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

Root Schema : publicSectorOpaEnumerations-EnumValueService-item

Type: object

Show Source

• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the enumeration value.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date on which the enumeration value was created.
• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates if the enumeration value is logically deleted. Valid values are Y for deleted, and N for an existing enumeration value. The default value is N.
• Description(optional): string
  Title: Description

  Maximum Length: 30

  The description of the enumeration value.
• EnumName(optional): string
  Title: Enumeration Name

  Maximum Length: 30

  The name of the enumeration that is associated with the enumeration value.
• EnumValue(optional): string
  Title: Enumeration Value

  Maximum Length: 50

  The value of the enumeration.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date on which the enumeration value was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

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

  Link Relations
• OwnerId(optional): string
  Maximum Length: 10

  The identifier of the owner who is associated with the enumeration value.
• SeedDataLock(optional): integer(int32)
  Indicates if the enumeration value is a seed data. Valid values are 0 for the data that is customer data, 1 for seed data that cannot be modified, and 2 indicates that the seed data can be modified.

{
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the enumeration value.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the enumeration value was created.",
            "title":"Creation Date"
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the enumeration value is logically deleted. Valid values are Y for deleted, and N for an existing enumeration value. The default value is N."
        },
        "Description":{
            "maxLength":30,
            "type":"string",
            "description":"The description of the enumeration value.",
            "title":"Description"
        },
        "EnumName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the enumeration that is associated with the enumeration value.",
            "title":"Enumeration Name"
        },
        "EnumValue":{
            "maxLength":50,
            "type":"string",
            "description":"The value of the enumeration.",
            "title":"Enumeration Value"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the enumeration value was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the enumeration value.",
            "title":"Last Updated By"
        },
        "OwnerId":{
            "maxLength":10,
            "type":"string",
            "description":"The identifier of the owner who is associated with the enumeration value."
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates if the enumeration value is a seed data. Valid values are 0 for the data that is customer data, 1 for seed data that cannot be modified, and 2 indicates that the seed data can be modified."
        },
        "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 : 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"
}

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 : publicSectorOpaEnumerations-EnumValueService-item

Type: object

Show Source

• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the enumeration value.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date on which the enumeration value was created.
• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates if the enumeration value is logically deleted. Valid values are Y for deleted, and N for an existing enumeration value. The default value is N.
• Description(optional): string
  Title: Description

  Maximum Length: 30

  The description of the enumeration value.
• EnumName(optional): string
  Title: Enumeration Name

  Maximum Length: 30

  The name of the enumeration that is associated with the enumeration value.
• EnumValue(optional): string
  Title: Enumeration Value

  Maximum Length: 50

  The value of the enumeration.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date on which the enumeration value was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

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

  Link Relations
• OwnerId(optional): string
  Maximum Length: 10

  The identifier of the owner who is associated with the enumeration value.
• SeedDataLock(optional): integer(int32)
  Indicates if the enumeration value is a seed data. Valid values are 0 for the data that is customer data, 1 for seed data that cannot be modified, and 2 indicates that the seed data can be modified.

{
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the enumeration value.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the enumeration value was created.",
            "title":"Creation Date"
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the enumeration value is logically deleted. Valid values are Y for deleted, and N for an existing enumeration value. The default value is N."
        },
        "Description":{
            "maxLength":30,
            "type":"string",
            "description":"The description of the enumeration value.",
            "title":"Description"
        },
        "EnumName":{
            "maxLength":30,
            "type":"string",
            "description":"The name of the enumeration that is associated with the enumeration value.",
            "title":"Enumeration Name"
        },
        "EnumValue":{
            "maxLength":50,
            "type":"string",
            "description":"The value of the enumeration.",
            "title":"Enumeration Value"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date on which the enumeration value was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the enumeration value.",
            "title":"Last Updated By"
        },
        "OwnerId":{
            "maxLength":10,
            "type":"string",
            "description":"The identifier of the owner who is associated with the enumeration value."
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates if the enumeration value is a seed data. Valid values are 0 for the data that is customer data, 1 for seed data that cannot be modified, and 2 indicates that the seed data can be modified."
        },
        "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 : 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"
}

Back to Top