Jump to

• Request
• Response
• Examples

Get Part Metadata Action

post

/rest/v16/partSetups/actions/getPartMetadata

Use this endpoint to retrieve return the metadata for CPQ standard and part custom fields.

Request

Supported Media Types

• application/json

Body ()

Root Schema : Part Setups Get Part Metdata Request Definition

Type: object

Title: Part Setups Get Part Metdata Request Definition

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Part Setups Get Part Metdata Response Definition

Type: object

Title: Part Setups Get Part Metdata Response Definition

Show Source

• partMetadata: object Part Metadata Response Model
  Title: Part Metadata Response Model

  The metadata definition for part setups.

{
    "type":"object",
    "properties":{
        "partMetadata":{
            "$ref":"#/definitions/getPartMetadataResponse"
        }
    },
    "title":"Part Setups Get Part Metdata Response Definition"
}

Nested Schema : Part Metadata Response Model

Type: object

Title: Part Metadata Response Model

The metadata definition for part setups.

Show Source

• partMetadata: object Part Metadata Response Field
  Title: Part Metadata Response Field

  The metadata definition for part setups.

{
    "type":"object",
    "properties":{
        "partMetadata":{
            "description":"The wrapper field for the part metadata definition.",
            "title":"Part Metadata",
            "$ref":"#/definitions/getPartMetadataResponseField"
        }
    },
    "title":"Part Metadata Response Model",
    "description":"The metadata definition for part setups."
}

Nested Schema : Part Metadata Response Field

Type: object

Title: Part Metadata Response Field

The metadata definition for part setups.

Show Source

• customFields: object Part Setups Custom Fields
  Title: Part Setups Custom Fields

  List of the custom fields for part setups.
• standardFields: object Part Setups Standard Fields
  Title: Part Setups Standard Fields

  List of the standard fields for part setups.

{
    "type":"object",
    "properties":{
        "standardFields":{
            "description":"The list of standard part setups fields.",
            "title":"Standard Fields",
            "$ref":"#/definitions/partSetupsStandardFields"
        },
        "customFields":{
            "description":"The list of custom part setups fields.",
            "title":"Custom Fields",
            "$ref":"#/definitions/partSetupsCustomFields"
        }
    },
    "title":"Part Metadata Response Field",
    "description":"The metadata definition for part setups."
}

Nested Schema : Part Setups Custom Fields

Type: object

Title: Part Setups Custom Fields

List of the custom fields for part setups.

Show Source

• customFields: array Custom Fields
  Title: Custom Fields

  The list of standard part setups fields.

{
    "type":"object",
    "properties":{
        "customFields":{
            "type":"array",
            "description":"The list of standard part setups fields.",
            "title":"Custom Fields",
            "items":{
                "$ref":"#/definitions/partSetupsStandardField"
            }
        }
    },
    "title":"Part Setups Custom Fields",
    "description":"List of the custom fields for part setups."
}

Nested Schema : Part Setups Standard Fields

Type: object

Title: Part Setups Standard Fields

List of the standard fields for part setups.

Show Source

• standardFields: array Standard Fields
  Title: Standard Fields

  The list of standard part setups fields.

{
    "type":"object",
    "properties":{
        "standardFields":{
            "type":"array",
            "description":"The list of standard part setups fields.",
            "title":"Standard Fields",
            "items":{
                "$ref":"#/definitions/partSetupsStandardField"
            }
        }
    },
    "title":"Part Setups Standard Fields",
    "description":"List of the standard fields for part setups."
}

Nested Schema : Custom Fields

Type: array

Title: Custom Fields

The list of standard part setups fields.

Show Source

• Array of: object Part Setups Standard Field
  Title: Part Setups Standard Field

  Single part setups standard field definition.

{
    "type":"array",
    "description":"The list of standard part setups fields.",
    "title":"Custom Fields",
    "items":{
        "$ref":"#/definitions/partSetupsStandardField"
    }
}

Nested Schema : Part Setups Standard Field

Type: object

Title: Part Setups Standard Field

Single part setups standard field definition.

Show Source

• fieldName: string
  Title: Field Name

  The name of the field.
• label: string
  Title: Label

  The label of the field.
• required: boolean
  Title: Required

  Whether the field is required.
• type: string
  Title: Type

  The type of the field.

{
    "type":"object",
    "properties":{
        "fieldName":{
            "type":"string",
            "description":"The name of the field.",
            "title":"Field Name"
        },
        "label":{
            "type":"string",
            "description":"The label of the field.",
            "title":"Label"
        },
        "required":{
            "type":"boolean",
            "description":"Whether the field is required.",
            "title":"Required"
        },
        "type":{
            "type":"string",
            "description":"The type of the field.",
            "title":"Type"
        }
    },
    "title":"Part Setups Standard Field",
    "description":"Single part setups standard field definition."
}

Nested Schema : Standard Fields

Type: array

Title: Standard Fields

The list of standard part setups fields.

Show Source

• Array of: object Part Setups Standard Field
  Title: Part Setups Standard Field

  Single part setups standard field definition.

{
    "type":"array",
    "description":"The list of standard part setups fields.",
    "title":"Standard Fields",
    "items":{
        "$ref":"#/definitions/partSetupsStandardField"
    }
}

Back to Top

Examples

The following example shows how to retrieve return the metadata for standard and part custom fields by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X POST - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v16/partSetups/actions/getPartMetadata

Response Body

{
  "partMetadata": {
    "standardFields": [{
        "fieldName": "dateAdded",
        "label": "Date Added",
        "required": true,
        "type": "Date"
      }, {
        "fieldName": "dateModified",
        "label": "Date Modified",
        "required": false,
        "type": "Date"
      }, {
        "fieldName": "defaultUOMCode",
        "label": "Default UOM Code",
        "required": false,
        "type": "String"
      }, {
        "fieldName": "description",
        "label": "Description",
        "required": false,
        "type": "String"
      }, {
        "fieldName": "directBuy",
        "label": "Direct Buy",
        "required": true,
        "type": "Single Select Menu"
      }, {
        "fieldName": "eligibleForService",
        "label": "Eligible for Service",
        "required": false,
        "type": "String"
      }, {
        "fieldName": "eligibleToSell",
        "label": "Eligible to Sell",
        "required": false,
        "type": "String"
      }, {
        "fieldName": "enableSelfService",
        "label": "Enable Customer Self-Service",
        "required": false,
        "type": "String"
      }, {
        "fieldName": "externalKey1",
        "label": "External Key 1",
        "required": false,
        "type": "String"
      }, {
        "fieldName": "externalKey2",
        "label": "External Key 2",
        "required": false,
        "type": "String"
      }, {
        "fieldName": "id",
        "label": "Id",
        "required": false,
        "type": "Integer"
      }, {
        "fieldName": "leadTime",
        "label": "Lead Time",
        "required": false,
        "type": "Integer"
      }, {
        "fieldName": "numberOfPricePeriods",
        "label": "Number of Price Periods",
        "required": false,
        "type": "Integer"
      }, {
        "fieldName": "partDisplayNumber",
        "label": "Part Display Number",
        "required": false,
        "type": "String"
      }, {
        "fieldName": "partNumber",
        "label": "Part Number",
        "required": true,
        "type": "String"
      }, {
        "fieldName": "partNumberLower",
        "label": "Part Number Lower",
        "required": false,
        "type": "String"
      }, {
        "fieldName": "partnerOrganizationId",
        "label": "Partner Organization Id",
        "required": false,
        "type": "String"
      }, {
        "fieldName": "partnerPartId",
        "label": "Partner Part Id",
        "required": false,
        "type": "String"
      }, {
        "fieldName": "partnerStandardPriceBookEntryId",
        "label": "Partner Standard Pricebook Entry Id",
        "required": false,
        "type": "String"
      }, {
        "fieldName": "pricePeriod",
        "label": "Price Period",
        "required": false,
        "type": "String"
      }, {
        "fieldName": "priceType",
        "label": "Price Type",
        "required": false,
        "type": "String"
      }, {
        "fieldName": "salesProductType",
        "label": "Sales Product Type",
        "required": false,
        "type": "String"
      }, {
        "fieldName": "units",
        "label": "Units",
        "required": false,
        "type": "String"
      }
    ],
    "customFields": [{
        "fieldName": "_part_custom_field1",
        "label": "Product Group",
        "required": false,
        "type": "String",
        "showOnSearchPage": false,
        "showOnSearchResultsPage": false,
        "showOnBomPage": false,
        "showOnDetailPage": false
      }, {
        "fieldName": "_part_custom_field10",
        "label": "Product type",
        "required": false,
        "type": "Single Select Menu",
        "showOnSearchPage": false,
        "showOnSearchResultsPage": false,
        "showOnBomPage": false,
        "showOnDetailPage": false
      }, {
        "fieldName": "_part_custom_field2",
        "label": "Part Availability",
        "required": false,
        "type": "Single Select Menu",
        "showOnSearchPage": true,
        "showOnSearchResultsPage": true,
        "showOnBomPage": false,
        "showOnDetailPage": false
      }, {
        "fieldName": "_part_custom_field3",
        "label": "Max discount %",
        "required": false,
        "type": "String",
        "showOnSearchPage": false,
        "showOnSearchResultsPage": false,
        "showOnBomPage": false,
        "showOnDetailPage": false
      }, {
        "fieldName": "_part_custom_field4",
        "label": "Price Period",
        "required": false,
        "type": "Single Select Menu",
        "showOnSearchPage": false,
        "showOnSearchResultsPage": false,
        "showOnBomPage": false,
        "showOnDetailPage": true
      }, {
        "fieldName": "_part_custom_field5",
        "label": "Cost",
        "required": false,
        "type": "Number",
        "showOnSearchPage": false,
        "showOnSearchResultsPage": false,
        "showOnBomPage": false,
        "showOnDetailPage": false
      }, {
        "fieldName": "_part_custom_field8",
        "label": "Price Type",
        "required": false,
        "type": "Single Select Menu",
        "showOnSearchPage": false,
        "showOnSearchResultsPage": false,
        "showOnBomPage": false,
        "showOnDetailPage": true
      }, {
        "fieldName": "_part_custom_field9",
        "label": "product",
        "required": false,
        "type": "String",
        "showOnSearchPage": false,
        "showOnSearchResultsPage": false,
        "showOnBomPage": false,
        "showOnDetailPage": false
      }
    ]
  }
}

Back to Top