Jump to

• Request
• Response

Update an enumeration

patch

/fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations/{EnumName}

Request

Path Parameters

• EnumName(required): string
  The name of the enumeration.

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ChildEnumName: string
  Title: Child Enumeration Name

  Maximum Length: 30

  The name of the child enumeration.
• CreatedOn: string (date-time)
  The date on which the enumeration was created.
• DeletedFlag: string
  Maximum Length: 1

  Default Value: N

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

  Maximum Length: 100

  The description of the enumeration.
• EnumName: string
  Title: Enumeration Name

  Maximum Length: 30

  The name of the enumeration.
• EnumType: string
  Title: Enumeration Type

  Maximum Length: 10

  The data type of the enumeration.
• EnumValueService: array Enumeration Values
  Title: Enumeration Values

  The enumeration values resource is used to view the values associated to a particular enumeration name.
• OwnerId: string
  Maximum Length: 10

  The identifier of the owner who is associated with the enumeration.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates if the enumeration is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified.
• UncertainValue: string
  Title: Uncertain Value

  Maximum Length: 40

  Indicates that the value for the enumeration is uncertain.
• UsesCustomTable: string
  Maximum Length: 1

  Indicates if the enumeration uses a user-defined table. Valid values are Y or N.
• ViewObjectId: number
  Title: View Object ID

  The identifier of the View object that is associated with the enumeration.

{
    "type":"object",
    "properties":{
        "ChildEnumName":{
            "title":"Child Enumeration Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the child enumeration.",
            "nullable":true
        },
        "CreatedOn":{
            "type":"string",
            "description":"The date on which the enumeration was created.",
            "format":"date-time",
            "nullable":true
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the enumeration is logically deleted. Valid values are Y for deleted, and N for existing enumeration. The default value is N.",
            "nullable":false,
            "default":"N"
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the enumeration.",
            "nullable":true
        },
        "EnumName":{
            "title":"Enumeration Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the enumeration.",
            "nullable":false
        },
        "EnumType":{
            "title":"Enumeration Type",
            "maxLength":10,
            "type":"string",
            "description":"The data type of the enumeration.",
            "nullable":true
        },
        "EnumValueService":{
            "title":"Enumeration Values",
            "type":"array",
            "description":"The enumeration values resource is used to view the values associated to a particular enumeration name.",
            "items":{
                "$ref":"#/components/schemas/publicSectorOpaEnumerations-EnumValueService-item-patch-request"
            }
        },
        "OwnerId":{
            "maxLength":10,
            "type":"string",
            "description":"The identifier of the owner who is associated with the enumeration.",
            "nullable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates if the enumeration is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":1
            }
        },
        "UncertainValue":{
            "title":"Uncertain Value",
            "maxLength":40,
            "type":"string",
            "description":"Indicates that the value for the enumeration is uncertain.",
            "nullable":true
        },
        "UsesCustomTable":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the enumeration uses a user-defined table. Valid values are Y or N.",
            "nullable":true
        },
        "ViewObjectId":{
            "title":"View Object ID",
            "type":"number",
            "description":"The identifier of the View object that is associated with the enumeration.",
            "nullable":true
        }
    }
}

Nested Schema : Enumeration Values

Type: array

Title: Enumeration Values

The enumeration values resource is used to view the values associated to a particular enumeration name.

Show Source

• Array of: object schema

{
    "title":"Enumeration Values",
    "type":"array",
    "description":"The enumeration values resource is used to view the values associated to a particular enumeration name.",
    "items":{
        "$ref":"#/components/schemas/publicSectorOpaEnumerations-EnumValueService-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• DeletedFlag: string
  Maximum Length: 1

  Default Value: N

  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: string
  Title: Description

  Maximum Length: 30

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

  Maximum Length: 30

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

  Maximum Length: 50

  The value of the enumeration.
• OwnerId: string
  Maximum Length: 10

  The identifier of the owner who is associated with the enumeration value.
• SeedDataLock: integer (int32)
  Default Value: 0

  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.

{
    "type":"object",
    "properties":{
        "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.",
            "nullable":false,
            "default":"N"
        },
        "Description":{
            "title":"Description",
            "maxLength":30,
            "type":"string",
            "description":"The description of the enumeration value.",
            "nullable":true
        },
        "EnumName":{
            "title":"Enumeration Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the enumeration that is associated with the enumeration value.",
            "nullable":false
        },
        "EnumValue":{
            "title":"Enumeration Value",
            "maxLength":50,
            "type":"string",
            "description":"The value of the enumeration.",
            "nullable":false
        },
        "OwnerId":{
            "maxLength":10,
            "type":"string",
            "description":"The identifier of the owner who is associated with the enumeration value.",
            "nullable":true
        },
        "SeedDataLock":{
            "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.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":1
            }
        }
    }
}

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

Type: object

Show Source

• ChildEnumName: string
  Title: Child Enumeration Name

  Maximum Length: 30

  The name of the child enumeration.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The name of the user who created the enumeration.
• CreatedOn: string (date-time)
  The date on which the enumeration was created.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  Default Value: N

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

  Maximum Length: 100

  The description of the enumeration.
• EnumName: string
  Title: Enumeration Name

  Maximum Length: 30

  The name of the enumeration.
• EnumType: string
  Title: Enumeration Type

  Maximum Length: 10

  The data type of the enumeration.
• EnumValueService: array Enumeration Values
  Title: Enumeration Values

  The enumeration values resource is used to view the values associated to a particular enumeration name.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The name of the user who last updated the enumeration.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The date on which the enumeration was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OwnerId: string
  Maximum Length: 10

  The identifier of the owner who is associated with the enumeration.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates if the enumeration is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified.
• UncertainValue: string
  Title: Uncertain Value

  Maximum Length: 40

  Indicates that the value for the enumeration is uncertain.
• UsesCustomTable: string
  Maximum Length: 1

  Indicates if the enumeration uses a user-defined table. Valid values are Y or N.
• ViewObjectId: number
  Title: View Object ID

  The identifier of the View object that is associated with the enumeration.

{
    "type":"object",
    "properties":{
        "ChildEnumName":{
            "title":"Child Enumeration Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the child enumeration.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the enumeration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedOn":{
            "type":"string",
            "description":"The date on which the enumeration was created.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which the enumeration was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the enumeration is logically deleted. Valid values are Y for deleted, and N for existing enumeration. The default value is N.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":100,
            "type":"string",
            "description":"The description of the enumeration.",
            "nullable":true,
            "x-queryable":true
        },
        "EnumName":{
            "title":"Enumeration Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the enumeration.",
            "nullable":false,
            "x-queryable":true
        },
        "EnumType":{
            "title":"Enumeration Type",
            "maxLength":10,
            "type":"string",
            "description":"The data type of the enumeration.",
            "nullable":true,
            "x-queryable":true
        },
        "EnumValueService":{
            "title":"Enumeration Values",
            "type":"array",
            "description":"The enumeration values resource is used to view the values associated to a particular enumeration name.",
            "items":{
                "$ref":"#/components/schemas/publicSectorOpaEnumerations-EnumValueService-item-response"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The name of the user who last updated the enumeration.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The date on which the enumeration was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerId":{
            "maxLength":10,
            "type":"string",
            "description":"The identifier of the owner who is associated with the enumeration.",
            "nullable":true,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates if the enumeration is a seed data. Valid values are 0 for the data that is customer data, 1 for the seed data that cannot be modified, and 2 indicates that the seed data can be modified.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "UncertainValue":{
            "title":"Uncertain Value",
            "maxLength":40,
            "type":"string",
            "description":"Indicates that the value for the enumeration is uncertain.",
            "nullable":true,
            "x-queryable":true
        },
        "UsesCustomTable":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the enumeration uses a user-defined table. Valid values are Y or N.",
            "nullable":true,
            "x-queryable":true
        },
        "ViewObjectId":{
            "title":"View Object ID",
            "type":"number",
            "description":"The identifier of the View object that is associated with the enumeration.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Enumeration Values

Type: array

Title: Enumeration Values

The enumeration values resource is used to view the values associated to a particular enumeration name.

Show Source

• Array of: object publicSectorOpaEnumerations-EnumValueService-item-response

{
    "title":"Enumeration Values",
    "type":"array",
    "description":"The enumeration values resource is used to view the values associated to a particular enumeration name.",
    "items":{
        "$ref":"#/components/schemas/publicSectorOpaEnumerations-EnumValueService-item-response"
    }
}

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

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Default Value: N

  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: string
  Title: Description

  Maximum Length: 30

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

  Maximum Length: 30

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

  Maximum Length: 50

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the enumeration value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OwnerId: string
  Maximum Length: 10

  The identifier of the owner who is associated with the enumeration value.
• SeedDataLock: integer (int32)
  Default Value: 0

  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.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the enumeration value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which the enumeration value was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "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.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":30,
            "type":"string",
            "description":"The description of the enumeration value.",
            "nullable":true,
            "x-queryable":true
        },
        "EnumName":{
            "title":"Enumeration Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the enumeration that is associated with the enumeration value.",
            "nullable":false,
            "x-queryable":true
        },
        "EnumValue":{
            "title":"Enumeration Value",
            "maxLength":50,
            "type":"string",
            "description":"The value of the enumeration.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the enumeration value was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the enumeration value.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerId":{
            "maxLength":10,
            "type":"string",
            "description":"The identifier of the owner who is associated with the enumeration value.",
            "nullable":true,
            "x-queryable":true
        },
        "SeedDataLock":{
            "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.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : 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."
        }
    }
}

Links

EnumValueService

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorOpaEnumerations/{EnumName}/child/EnumValueService

Parameters:

• EnumName: $request.path.EnumName

The enumeration values resource is used to view the values associated to a particular enumeration name.

Back to Top