Zum Hauptinhalt springen
GET
/
media-bridge
/
v1
/
{appId}
/
settings
/
object-definitions
/
{mediaType}
Objekttypen für ein unterstütztes Medienelement abrufen
curl --request GET \
  --url https://api.hubapi.com/media-bridge/v1/{appId}/settings/object-definitions/{mediaType}
{
  "objectTypeId": "<string>",
  "objectTypeName": "<string>",
  "properties": [
    {
      "calculationExpression": "<any>",
      "calculationFormula": "<string>",
      "definitionSource": {
        "name": "<string>",
        "type": "GLOBAL"
      },
      "extensionData": {
        "caseChangeTestExtensionData": {
          "mood": "<string>"
        },
        "extensionStatusMap": {},
        "optionDecoratorsExtensionData": {
          "optionDecoratorStyle": "<string>",
          "optionDecorators": {}
        },
        "requiredPropertiesExtensionData": {
          "isRequiredProperty": true
        },
        "softRequiredPropertiesExtensionData": {
          "isSoftRequiredProperty": true
        },
        "tags": [
          "<string>"
        ]
      },
      "externalOptionsMetaData": {
        "filter": {
          "includeUnconfirmedUsers": true,
          "pipelineIds": [
            "<string>"
          ]
        },
        "relatedObjectTypeId": "<string>"
      },
      "fulcrumPortalId": 123,
      "fulcrumTimestamp": 123,
      "janusGroup": "<string>",
      "objectTypeId": "<string>",
      "permission": {
        "accessLevel": "<string>"
      },
      "property": {
        "allowedObjectTypes": [
          {
            "innerId": 123,
            "metaTypeId": 123
          }
        ],
        "calculated": true,
        "canArchive": true,
        "canRestore": true,
        "createdAt": 123,
        "createdUserId": 123,
        "currencyPropertyName": "<string>",
        "dataSensitivity": "high",
        "dateDisplayHint": "absolute",
        "deleted": true,
        "description": "<string>",
        "displayMode": "all_unique_versions",
        "displayOrder": 123,
        "enforceMultivalueUniqueness": true,
        "externalOptions": true,
        "externalOptionsReferenceType": "<string>",
        "favorited": true,
        "favoritedOrder": 123,
        "fieldType": "<string>",
        "formField": true,
        "fromUserId": 123,
        "groupName": "<string>",
        "hasUniqueValue": true,
        "hidden": true,
        "hubspotDefined": true,
        "isCustomizedDefault": true,
        "isMultiValued": true,
        "isPartial": true,
        "label": "<string>",
        "mutableDefinitionNotDeletable": true,
        "name": "<string>",
        "numberDisplayHint": "currency",
        "optionSortStrategy": "ALPHABETICAL",
        "options": [
          {
            "description": "<string>",
            "displayOrder": 123,
            "doubleData": 123,
            "hidden": true,
            "label": "<string>",
            "readOnly": true,
            "value": "<string>"
          }
        ],
        "optionsAreMutable": true,
        "owningAppId": 123,
        "portalId": 123,
        "readOnlyDefinition": true,
        "readOnlyValue": true,
        "referencedObjectType": "ABANDONED_CART",
        "searchTextAnalysisMode": "NONE",
        "searchableInGlobalSearch": true,
        "sensitiveDataCategories": [
          "<string>"
        ],
        "showCurrencySymbol": true,
        "textDisplayHint": "domain_name",
        "type": "bool",
        "updatedAt": 123
      },
      "propertyDefinitionSource": {
        "name": "<string>",
        "type": "<string>"
      },
      "propertyRequirements": {
        "gates": [
          "<string>"
        ],
        "operator": "AND",
        "scopeNames": [
          "<string>"
        ],
        "settings": [
          "<string>"
        ]
      },
      "rollupExpression": {
        "associationTypes": [
          {
            "associationCategory": "HUBSPOT_DEFINED",
            "associationTypeId": 123
          }
        ],
        "conditionalExpression": "<any>",
        "conditionalFormula": "<string>",
        "emptyRollupValue": "<string>",
        "rollupOperator": "<string>",
        "sourceCompareByPropertyName": "<string>",
        "sourceObjectTypeId": "<string>",
        "sourcePropertyName": "<string>"
      }
    }
  ],
  "propertyGroups": [
    {
      "displayName": "<string>",
      "displayOrder": 123,
      "fulcrumPortalId": 123,
      "fulcrumTimestamp": 123,
      "hubspotDefined": true,
      "name": "<string>"
    }
  ],
  "schema": {
    "accessScopeName": "<string>",
    "allowsSensitiveProperties": true,
    "createDatePropertyName": "<string>",
    "createdAt": 123,
    "defaultSearchPropertyNames": [
      "<string>"
    ],
    "deleted": true,
    "description": "<string>",
    "fullyQualifiedName": "<string>",
    "hasCustomProperties": true,
    "hasDefaultProperties": true,
    "hasExternalObjectIds": true,
    "hasOwners": true,
    "hasPipelines": true,
    "id": 123,
    "indexedForFiltersAndReports": true,
    "integrationAppId": 123,
    "janusGroup": "<string>",
    "lastModifiedPropertyName": "<string>",
    "metaType": "CMS_HUBDB",
    "metaTypeId": 123,
    "name": "<string>",
    "objectTypeId": "<string>",
    "ownerPortalId": 123,
    "permissioningType": "<string>",
    "pipelineCloseDatePropertyName": "<string>",
    "pipelinePropertyName": "<string>",
    "pipelineStagePropertyName": "<string>",
    "pipelineTimeToClosePropertyName": "<string>",
    "pluralForm": "<string>",
    "primaryDisplayLabelPropertyName": "<string>",
    "readScopeName": "<string>",
    "requiredProperties": [
      "<string>"
    ],
    "restorable": true,
    "scopeMappings": [
      {
        "accessLevel": "<string>",
        "requestAction": "<string>",
        "scopeName": "<string>"
      }
    ],
    "secondaryDisplayLabelPropertyNames": [
      "<string>"
    ],
    "singularForm": "<string>",
    "status": "<string>",
    "visibility": "<string>",
    "writeScopeName": "<string>"
  }
}
Unterstützte Produkte
Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing HubKostenlos
Sales HubSales HubKostenlos
Service HubService HubKostenlos
Content HubContent HubKostenlos

Authorizations

hapikey
string
query
required

Path Parameters

appId
integer
required

Die appId für die Media-Bridge-App. In Ihrem Entwickler-Account können mehrere Apps vorhanden sein, die die Media Bridge verwenden.

mediaType
enum<string>
required

Rufen Sie den Medientyp ab, für den Sie die Objekttypen abrufen möchten.

Verfügbare Optionen:
AUDIO,
DOCUMENT,
IMAGE,
OTHER,
VIDEO

Query Parameters

includeFullDefinition
boolean

Schließen Sie die vollständige Definition in der Antwort ein.

Response

successful operation

objectTypeId
string
required
objectTypeName
string
required
properties
object[]
required
propertyGroups
object[]
required
schema
object