Jump to

• Request
• Response

Create a Description

post

/items/{itemGid}/descriptions

Request

Path Parameters

• itemGid(required): string
  Resource ID

Supported Media Types

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

Request Body - application/vnd.oracle.resource+json;type=collection ()

Root Schema : schema

Type: object

Show Source

• items(required): array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object schema

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

Nested Schema : schema

Type: object

Show Source

• description: string
  Description text.
• domainName: string
  Database domain where this data is stored.
• gtmLanguageGid: string
  The GID for the country that is being used to qualify the language associated with the description.
• links: array links
  Read Only: true
• seqNo: number (double)
  Internal sequence number for the description.

{
    "properties":{
        "seqNo":{
            "description":"Internal sequence number for the description.",
            "type":"number",
            "format":"double"
        },
        "description":{
            "description":"Description text.",
            "type":"string"
        },
        "gtmLanguageGid":{
            "description":"The GID for the country that is being used to qualify the language associated with the description. ",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "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"
        }
    }
}

Request Body - application/vnd.oracle.resource+json;type=singular ()

Root Schema : schema

Type: object

Show Source

• description: string
  Description text.
• domainName: string
  Database domain where this data is stored.
• gtmLanguageGid: string
  The GID for the country that is being used to qualify the language associated with the description.
• links: array links
  Read Only: true
• seqNo: number (double)
  Internal sequence number for the description.

{
    "properties":{
        "seqNo":{
            "description":"Internal sequence number for the description.",
            "type":"number",
            "format":"double"
        },
        "description":{
            "description":"Description text.",
            "type":"string"
        },
        "gtmLanguageGid":{
            "description":"The GID for the country that is being used to qualify the language associated with the description. ",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "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

Response

Supported Media Types

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

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• description: string
  Description text.
• domainName: string
  Database domain where this data is stored.
• gtmLanguageGid: string
  The GID for the country that is being used to qualify the language associated with the description.
• links: array links
  Read Only: true
• seqNo: number (double)
  Internal sequence number for the description.

{
    "properties":{
        "seqNo":{
            "description":"Internal sequence number for the description.",
            "type":"number",
            "format":"double"
        },
        "description":{
            "description":"Description text.",
            "type":"string"
        },
        "gtmLanguageGid":{
            "description":"The GID for the country that is being used to qualify the language associated with the description. ",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "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