Retrieve a mapping - HubSpot docs

Supported products

Required Scopes

承認

Authorization

string

header

必須

The access token received from the authorization server in the OAuth 2.0 flow.

パスパラメータ

integer<int64>

必須

レスポンス

successful operation

cdnPurgeEmbargoTime

integer<int64>

必須

contentGroupId

integer<int64>

必須

cosObjectType

enum<string>

必須

利用可能なオプション:

ACCESS_GROUP_MEMBERSHIP,

APP_PAGE,

BLOCK,

BLOG,

BLOG_AUTHOR,

BRAND_BUSINESS_UNIT,

BRAND_SETTINGS,

CONTACT_MEMBERSHIP,

CONTENT,

CONTENT_EMBED,

CONTENT_FOLDER,

CONTENT_GROUP,

CRM_OBJECT,

CRM_OBJECT_TYPE,

CUSTOM_WIDGET,

CUSTOMER_PORTAL,

DATA_QUERY,

DESIGN_FOLDER,

DOMAIN,

DOMAIN_SETTINGS,

EMAIL_ADDRESS,

EXTENSION_RESOURCE,

FILE,

FOLDER,

FOLLOW_ME,

FORM,

GLOBAL_CONTENT,

GLOBAL_STYLES_THEME,

HUBDB_TABLE,

HUBDB_TABLE_ROW,

IMAGE,

JS_PROJECT_COMPONENT,

KNOWLEDGE_BASE,

KNOWLEDGE_CATEGORY,

KNOWLEDGE_CATEGORY_TRANSLATION,

KNOWLEDGE_HOMEPAGE_CATEGORY,

LAYOUT,

LAYOUT_SECTION,

LIST_MEMBERSHIP,

MARKETPLACE_LISTING,

PASSWORD_PROTECTED,

PAYMENT,

PERSONALIZATION_TOKEN,

PLACEMENT,

PROJECT,

QUOTE_TEMPLATE,

RAW_ASSET,

REDIRECT_URL,

SECTION,

SERVERLESS_FUNCTION,

SITE_MAP,

SITE_MENU,

SITE_SETTINGS,

SUBSCRIPTIONS_SETTINGS,

TAG,

THEME,

THEME_SETTINGS,

UNRESTRICTED_ACCESS,

URL_MAPPING,

VIDEO_PLAYER,

WIDGET,

WORKFLOW

created

integer<int64>

必須

createdById

integer<int32>

必須

deletedAt

integer<int64>

必須

destination

string

必須

The destination URL, where the target URL should be redirected if it matches the routePrefix.

integer<int64>

必須

The unique ID of this URL redirect.

internallyCreated

boolean

必須

isActive

boolean

必須

isMatchFullUrl

boolean

必須

Whether the routePrefix should match on the entire URL, including the domain.

isMatchQueryString

boolean

必須

Whether the routePrefix should match on the entire URL path, including the query string.

isOnlyAfterNotFound

boolean

必須

Whether the URL redirect mapping should apply only if a live page on the URL isn't found. If False, the URL redirect mapping will take precedence over any existing page.

isPattern

boolean

必須

Whether the routePrefix should match based on pattern.

isProtocolAgnostic

boolean

必須

Whether the routePrefix should match both HTTP and HTTPS protocols.

isRegex

boolean

必須

isTrailingSlashOptional

boolean

必須

Whether a trailing slash will be ignored.

label

string

必須

lastUsedAt

integer<int64>

必須

name

string

必須

note

string

必須

portalId

integer<int32>

必須

precedence

integer<int32>

必須

Used to prioritize URL redirection. If a given URL matches more than one redirect, the one with the lower precedence will be used.

redirectStyle

integer<int32>

必須

The type of redirect to create. Options include: 301 (permanent), 302 (temporary), or 305 (proxy). Find more details here.

routePrefix

string

必須

The target incoming URL, path, or pattern to match for redirection.

updated

integer<int64>

必須

updatedById

integer<int32>

必須