Jump to

• Request
• Response
• Examples

Create Extended Descriptions for a Part

post

/rest/v19/partSetups/{id}/extendedDescriptions

Use this endpoint to create extended descriptions for a CPQ part without an extended descriptions object. Note: If the Extended Descriptions object exists, even though the descriptions are empty, you should use Update Part Extended Descriptions to populate the extended descriptions.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): integer
  The unique identifier for the part.

Body ()

Root Schema : Part Extended Descriptions

Type: object

Title: Part Extended Descriptions

Show Source

• dateAdded: string
  Title: Date Added

  System field indicating the date on which the Resource was created.
• dateModified: string
  Title: Date Modified

  System field indicating the date on which the Resource was last modified.
• id: integer
  Title: Id

  Identifier for the resource
• partExtendedDescription1: string
  Title: Extended Description 1

  Part extended description 1
• partExtendedDescription2: string
  Title: Extended Description 2

  Part extended description 2
• translations: object Part Extended Description Translations
  Title: Part Extended Description Translations

{
    "type":"object",
    "properties":{
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "id":{
            "type":"integer",
            "description":"Identifier for the resource",
            "title":"Id"
        },
        "partExtendedDescription1":{
            "type":"string",
            "description":"Part extended description 1",
            "title":"Extended Description 1"
        },
        "partExtendedDescription2":{
            "type":"string",
            "description":"Part extended description 2",
            "title":"Extended Description 2"
        },
        "translations":{
            "$ref":"#/definitions/partSetupExtendedDescriptionTranslations-createformcollection"
        }
    },
    "title":"Part Extended Descriptions"
}

Nested Schema : Part Extended Description Translations

Type: object

Title: Part Extended Description Translations

Show Source

• items: array items

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/partSetupExtendedDescriptionTranslations-createform"
            }
        }
    },
    "title":"Part Extended Description Translations"
}

Nested Schema : items

Type: array

Show Source

• Array of: object Part Extended Description Translations
  Title: Part Extended Description Translations

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/partSetupExtendedDescriptionTranslations-createform"
    }
}

Nested Schema : Part Extended Description Translations

Type: object

Title: Part Extended Description Translations

Show Source

• dateAdded: string
  Title: Date Added

  System field indicating the date on which the Resource was created.
• dateModified: string
  Title: Date Modified

  System field indicating the date on which the Resource was last modified.
• id: integer
  Title: Id

  Identifier for the resource
• language: object Language
  Title: Language

  The defined language of the rows translated columns.
• partExtendedDescription1: string
  Title: Extended Description 1

  Part extended description 1
• partExtendedDescription2: string
  Title: Extended Description 2

  Part extended description 2

{
    "type":"object",
    "properties":{
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "id":{
            "type":"integer",
            "description":"Identifier for the resource",
            "title":"Id"
        },
        "language":{
            "type":"object",
            "description":"The defined language of the rows translated columns.",
            "title":"Language",
            "properties":{
                "languageNumber":{
                    "type":"integer",
                    "description":"Unique language number.",
                    "title":"Language Number"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the language resource.",
                    "title":"Id"
                },
                "languageCode":{
                    "type":"string",
                    "description":"Unique language code",
                    "title":"Language Code"
                }
            }
        },
        "partExtendedDescription1":{
            "type":"string",
            "description":"Part extended description 1",
            "title":"Extended Description 1"
        },
        "partExtendedDescription2":{
            "type":"string",
            "description":"Part extended description 2",
            "title":"Extended Description 2"
        }
    },
    "title":"Part Extended Description Translations"
}

Nested Schema : Language

Type: object

Title: Language

The defined language of the rows translated columns.

Show Source

• id: integer
  Title: Id

  Primary Key of the language resource.
• languageCode: string
  Title: Language Code

  Unique language code
• languageNumber: integer
  Title: Language Number

  Unique language number.

{
    "type":"object",
    "description":"The defined language of the rows translated columns.",
    "title":"Language",
    "properties":{
        "languageNumber":{
            "type":"integer",
            "description":"Unique language number.",
            "title":"Language Number"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the language resource.",
            "title":"Id"
        },
        "languageCode":{
            "type":"string",
            "description":"Unique language code",
            "title":"Language Code"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Part Extended Descriptions

Type: object

Title: Part Extended Descriptions

Show Source

• dateAdded: string
  Title: Date Added

  System field indicating the date on which the Resource was created.
• dateModified: string
  Title: Date Modified

  System field indicating the date on which the Resource was last modified.
• id: integer
  Title: Id

  Identifier for the resource
• partExtendedDescription1: string
  Title: Extended Description 1

  Part extended description 1
• partExtendedDescription2: string
  Title: Extended Description 2

  Part extended description 2

{
    "type":"object",
    "properties":{
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "id":{
            "type":"integer",
            "description":"Identifier for the resource",
            "title":"Id"
        },
        "partExtendedDescription1":{
            "type":"string",
            "description":"Part extended description 1",
            "title":"Extended Description 1"
        },
        "partExtendedDescription2":{
            "type":"string",
            "description":"Part extended description 2",
            "title":"Extended Description 2"
        }
    },
    "title":"Part Extended Descriptions"
}

Back to Top

Examples

The following example shows how to create extended descriptions for a CPQ part by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X POST -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/partSetups/39644116/extendedDescriptions

Request Body

{
  "partExtendedDescription1": "Sample content for extended part description 1",
  "partExtendedDescription2": "Sample content for extended part description 2"
}

Request Body

{
  "hasMore": false,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/partSetups/39644116/extendedDescriptions"
    }
  ],
  "items": [{
      "partExtendedDescription1": "Sample content for extended part description 1",
      "dateModified": "2023-03-02T20:47:12.000Z",
      "id": 39653270,
      "partExtendedDescription2": "Sample content for extended part description 2",
      "dateAdded": "2021-09-22T09:01:06.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/partSetups/39644116/extendedDescriptions/38653270"
        }, {
          "kind": "",
          "rel": "child",
          "name": "translations",
          "href": "https://sitename.oracle.com/rest/v19/partSetups/39644116/extendedDescriptions/39653270/translations"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/partSetups/39644116"
        }
      ]
    }
  ]
}

Back to Top