Docs

Preview Pull Resource Type From Org

GET /resourceTypes/{resourceTypeId}/pull-from-org/preview

GET/resourceTypes/{resourceTypeId}/pull-from-org/preview

Required Tokens

FieldTypeRequiredDescription
BearerAuthorization: Bearer <api-key>OptionalYour API key. Pass it as the Bearer token on every request.
Event tokenx-Event-TokenOptionalRun **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually.
Organization tokenx-Organization-TokenOptionalSet the `orgToken` variable to a token from the Organization API's **Authorize Organization**. It must be for the event's owning organization.

Reads what a refresh from the org library would do, without writing. Use unresolvedVariants to build the variantResolutions the refresh needs.

Requires ResourceTypeDatabase.Read on the event's owning organization.
Event scoping: This endpoint does not include {eventId} in the URL. The event is determined automatically from your x-Event-Token.

Path Parameters

FieldTypeRequiredDescription
resourceTypeIdGuidRequiredA correlated event resource type.

Response Fields

FieldTypeDescription
resourceTypeId / nameGuid / stringThe event type.
newVariantAxesstring[]Variant-defining attributes arriving that this copy lacks.
variantsRefreshedFromOrgintCorrelated variants whose values are overwritten.
rateCardsAddedintOrg cards with no event copy yet.
rateCardsRefreshedFromOrgintCorrelated cards whose content is overwritten.
componentsAdded / componentsRemovedintA composite's component changes.
componentTypesPulledstring[]Component target types pulled alongside.
incomingVariantsarray`{ orgVariantId, name, isBase, eventVariantId }`.
unresolvedVariantsarray`{ eventVariantId, name, boundResourceCount, boundNeedCount }`: event variants the refresh can't place on its own.

Error Codes

HTTP StatusDescription
400The type isn't correlated to the org library.
403Org token for another organization, or missing ResourceTypeDatabase.Read.