Jump to

• Request
• Response
• Examples

Get Product Family Integration Metadata

get

/rest/v19/productFamilies/{prodFamVarName}/integrations

This endpoint returns metadata for the specified Product Family integration.

Request

Path Parameters

• prodFamVarName(required): string
  Product family variable name.

Query Parameters

• excludeLinks: string
  Exclude links.
• expand: string
  Allows expansion of relationships.

Back to Top

Response

Supported Media Types

• application/json

Default Response

List of integrations defined at product family level.

Body ()

Root Schema : integration-collection

Type: object

Show Source

• items: array Integrations
  Title: Integrations

  List of integrations.
• links: object Reference Links
  Title: Reference Links

  Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of integrations.",
            "title":"Integrations",
            "items":{
                "$ref":"#/definitions/integration"
            }
        },
        "links":{
            "$ref":"#/definitions/links"
        }
    }
}

Nested Schema : Integrations

Type: array

Title: Integrations

List of integrations.

Show Source

• Array of: object integration

{
    "type":"array",
    "description":"List of integrations.",
    "title":"Integrations",
    "items":{
        "$ref":"#/definitions/integration"
    }
}

Nested Schema : Reference Links

Type: object

Title: Reference Links

Reference links for the Parent, Self, Children and Related as applicable

Show Source

• href: string
  Title: href

  URL to the related object
• rel: string
  Title: Link

  Link relationship to the current object

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link relationship to the current object",
            "title":"Link"
        },
        "href":{
            "type":"string",
            "description":"URL to the related object",
            "title":"href"
        }
    },
    "title":"Reference Links",
    "description":"Reference links for the Parent, Self, Children and Related as applicable"
}

Nested Schema : integration

Type: object

Show Source

• links: object Reference Links
  Title: Reference Links

  Reference links for the Parent, Self, Children and Related as applicable
• name: string
  Title: Integration Name

  Integration display name.
• translations: object integrationTranslation-collection
• variableName: string
  Title: Integration Variable Name

  Unique variable name to identify the integration.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Integration display name.",
            "title":"Integration Name"
        },
        "variableName":{
            "type":"string",
            "description":"Unique variable name to identify the integration.",
            "title":"Integration Variable Name"
        },
        "translations":{
            "$ref":"#/definitions/integrationTranslation-collection"
        },
        "links":{
            "$ref":"#/definitions/links"
        }
    }
}

Nested Schema : integrationTranslation-collection

Type: object

Show Source

• items: array Translations
  Title: Translations

  List of translations for product integration.
• links: object Reference Links
  Title: Reference Links

  Reference links for the Parent, Self, Children and Related as applicable

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of translations for product integration.",
            "title":"Translations",
            "items":{
                "$ref":"#/definitions/integrationTranslation"
            }
        },
        "links":{
            "$ref":"#/definitions/links"
        }
    }
}

Nested Schema : Translations

Type: array

Title: Translations

List of translations for product integration.

Show Source

• Array of: object integrationTranslation

{
    "type":"array",
    "description":"List of translations for product integration.",
    "title":"Translations",
    "items":{
        "$ref":"#/definitions/integrationTranslation"
    }
}

Nested Schema : integrationTranslation

Type: object

Show Source

• language: object language
• links: object Reference Links
  Title: Reference Links

  Reference links for the Parent, Self, Children and Related as applicable
• name: string
  Title: Name

  Name.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name.",
            "title":"Name"
        },
        "language":{
            "$ref":"#/definitions/language"
        },
        "links":{
            "$ref":"#/definitions/links"
        }
    }
}

Nested Schema : language

Type: object

Show Source

• languageCode: string
  Title: Language Code

  Language Code
• languageNumber: integer
  Title: Language Number

  Unique language number.

{
    "type":"object",
    "properties":{
        "languageCode":{
            "$ref":"#/definitions/languageCode"
        },
        "languageNumber":{
            "type":"integer",
            "description":"Unique language number.",
            "title":"Language Number"
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve the metadata for the specified Configuration item by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/productFamilies/integration/integrations

Response Body Sample

{
  "items": [{
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/productFamilies/integration"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/productFamilies/integration/integrations/integrationAction"
        }
      ],
      "name": "Integration Action",
      "variableName": "integrationAction",
      "translations": {
        "items": [{
            "language": {
              "languageCode": "en",
              "languageNumber": -1
            },
            "name": "Integration Action"
          }, {
            "language": {
              "languageCode": "de",
              "languageNumber": 0
            },
            "name": "Integration Action_ößü"
          }
        ]
      }
    }
  ],
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/productFamilies/integration/integrations"
    }
  ]

Back to Top