Jump to

• Request
• Response

Get Code Attributes

get

/items/{itemGid}/classifications/{gtmItemClassificationGid}/codeAttributes

Request

Path Parameters

• gtmItemClassificationGid(required): string
  Resource ID
• itemGid(required): string
  Resource ID

Query Parameters

• expand: string
  Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
• fields: string
  Comma-delimited string of field names that you wanted returned in a GET request.
• limit: integer(int32)
  Positive integer value that specifies the maximum number of items returned by the server.
• offset: integer(int32)
  Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
• orderBy: string
  Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
• q: string
  Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
• totalResults: boolean
  Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=collection

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• items(required): array items
• links: array links

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/items.classifications.codeAttributes"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object items.classifications.codeAttributes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/items.classifications.codeAttributes"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    }
}

Nested Schema : items.classifications.codeAttributes

Type: object

Show Source

• attributeDescription: string
  The attribute description of the GTM product classification code attribute that is being added, updated, or deleted. The Description field has been configured to display all associated license control and license exception description attributes.
• attributeName: string
  The attribute name of the GTM product classification code attribute that is being added, updated, or deleted.
• attributeSequence: number (int64)
  The sequence number for the GTM product classification code attribute that is being added, updated, or deleted.
• attributeValue: string
  The attribute value - qualified by the attribute name - of the GTM product classification code attribute that is being added, updated, or deleted.
• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true

{
    "properties":{
        "attributeSequence":{
            "description":"The sequence number for the GTM product classification code attribute that is being added, updated, or deleted.",
            "type":"number",
            "format":"int64"
        },
        "attributeName":{
            "description":"The attribute name of the GTM product classification code attribute that is being added, updated, or deleted.",
            "type":"string"
        },
        "attributeValue":{
            "description":"The attribute value - qualified by the attribute name -  of the GTM product classification code attribute that is being added, updated, or deleted.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "attributeDescription":{
            "description":"The attribute description of the GTM product classification code attribute that is being added, updated, or deleted. The Description field has been configured to display all associated license control and license exception description attributes.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Back to Top