Jump to

• Request
• Response

Update an enumeration value

patch

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

Request

Path Parameters

• EnumName(required): string
  The name of the enumeration.
• EnumValueServiceUniqID(required): string
  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>

Header Parameters

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

Supported Media Types

• application/json

Request Body - application/json ()

Root 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":{
        "Description":{
            "title":"Description",
            "maxLength":"30",
            "type":"string",
            "description":"The description of the enumeration value.",
            "nullable":true
        },
        "OwnerId":{
            "maxLength":"10",
            "type":"string",
            "description":"The identifier of the owner who is associated with 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
        },
        "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"
            }
        },
        "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"
        }
    }
}

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-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":{
        "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
        },
        "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
        },
        "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
        },
        "Description":{
            "title":"Description",
            "maxLength":"30",
            "type":"string",
            "description":"The description of the enumeration value.",
            "nullable":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
        },
        "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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        }
    }
}

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

Back to Top