Jump to

• Request
• Response

Update an attribute

patch

/fscmRestApi/resources/11.13.18.05/spendClassificationAttributes/{AttributeMapId}

Request

Path Parameters

• AttributeMapId(required): integer(int64)
  Unique identifier for the attribute mapping.

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

• OperationName: string
  Value of the operation performed on attributes.
• SourceColumn: string
  Maximum Length: 128

  Column in the source table that is mapped to the attribute.
• SourceTable: string
  Maximum Length: 128

  Table from which the value for attribute is used.
• UseForClassificationCode: string
  Maximum Length: 80

  Abbreviation that determines if attribute is used for classification.

{
    "type":"object",
    "properties":{
        "OperationName":{
            "type":"string",
            "description":"Value of the operation performed on attributes.",
            "nullable":true
        },
        "SourceColumn":{
            "maxLength":128,
            "type":"string",
            "description":"Column in the source table that is mapped to the attribute.",
            "nullable":true
        },
        "SourceTable":{
            "maxLength":128,
            "type":"string",
            "description":"Table from which the value for attribute is used.",
            "nullable":true
        },
        "UseForClassificationCode":{
            "maxLength":80,
            "type":"string",
            "description":"Abbreviation that determines if attribute is used for classification.",
            "nullable":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 : spendClassificationAttributes-item-response

Type: object

Show Source

• AttributeCode: string
  Read Only: true

  Maximum Length: 80

  Abbreviation that identifies an attribute.
• AttributeDisplayName: string
  Read Only: true

  Maximum Length: 80

  Display name of the attribute.
• AttributeMapId: integer (int64)
  Read Only: true

  Unique identifier for the attribute mapping.
• AttributeName: string
  Read Only: true

  Maximum Length: 80

  Name of the attribute.
• AttributeType: string
  Read Only: true

  Maximum Length: 80

  Type of the attribute.
• AttributeTypeCode: string
  Read Only: true

  Maximum Length: 80

  Abbreviation that identifies the type of the attribute.
• DatasetDescription: string
  Read Only: true

  Maximum Length: 80

  Description of the data set.
• DatasetName: string
  Read Only: true

  Maximum Length: 80

  Name of the data set.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the attribute or it's mapping was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OperationName: string
  Value of the operation performed on attributes.
• SourceColumn: string
  Maximum Length: 128

  Column in the source table that is mapped to the attribute.
• SourceTable: string
  Maximum Length: 128

  Table from which the value for attribute is used.
• UseForClassification: string
  Read Only: true

  Maximum Length: 80

  Yes or No value that determines if attribute is used for classification.
• UseForClassificationCode: string
  Maximum Length: 80

  Abbreviation that determines if attribute is used for classification.

{
    "type":"object",
    "properties":{
        "AttributeCode":{
            "maxLength":80,
            "type":"string",
            "description":"Abbreviation that identifies an attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeDisplayName":{
            "maxLength":80,
            "type":"string",
            "description":"Display name of the attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AttributeMapId":{
            "type":"integer",
            "description":"Unique identifier for the attribute mapping.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeType":{
            "maxLength":80,
            "type":"string",
            "description":"Type of the attribute.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "AttributeTypeCode":{
            "maxLength":80,
            "type":"string",
            "description":"Abbreviation that identifies the type of the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DatasetDescription":{
            "maxLength":80,
            "type":"string",
            "description":"Description of the data set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DatasetName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the data set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the attribute or it's mapping was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationName":{
            "type":"string",
            "description":"Value of the operation performed on attributes.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceColumn":{
            "maxLength":128,
            "type":"string",
            "description":"Column in the source table that is mapped to the attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceTable":{
            "maxLength":128,
            "type":"string",
            "description":"Table from which the value for attribute is used.",
            "nullable":true,
            "x-queryable":true
        },
        "UseForClassification":{
            "maxLength":80,
            "type":"string",
            "description":"Yes or No value that determines if attribute is used for classification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "UseForClassificationCode":{
            "maxLength":80,
            "type":"string",
            "description":"Abbreviation that determines if attribute is used for classification.",
            "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 : 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