Docs
Preview Pull Resource Type From Org
GET /resourceTypes/{resourceTypeId}/pull-from-org/preview
GET
/resourceTypes/{resourceTypeId}/pull-from-org/previewRequired Tokens
| Field | Type | Required | Description |
|---|---|---|---|
| Bearer | Authorization: Bearer <api-key> | Optional | Your API key. Pass it as the Bearer token on every request. |
| Event token | x-Event-Token | Optional | Run **Get Tokens** in the Authorization folder, or call `GET /Events/{eventId}/authorize` manually. |
| Organization token | x-Organization-Token | Optional | Set 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
| Field | Type | Required | Description |
|---|---|---|---|
| resourceTypeId | Guid | Required | A correlated event resource type. |
Response Fields
| Field | Type | Description |
|---|---|---|
| resourceTypeId / name | Guid / string | The event type. |
| newVariantAxes | string[] | Variant-defining attributes arriving that this copy lacks. |
| variantsRefreshedFromOrg | int | Correlated variants whose values are overwritten. |
| rateCardsAdded | int | Org cards with no event copy yet. |
| rateCardsRefreshedFromOrg | int | Correlated cards whose content is overwritten. |
| componentsAdded / componentsRemoved | int | A composite's component changes. |
| componentTypesPulled | string[] | Component target types pulled alongside. |
| incomingVariants | array | `{ orgVariantId, name, isBase, eventVariantId }`. |
| unresolvedVariants | array | `{ eventVariantId, name, boundResourceCount, boundNeedCount }`: event variants the refresh can't place on its own. |
Error Codes
| HTTP Status | Description |
|---|---|
| 400 | The type isn't correlated to the org library. |
| 403 | Org token for another organization, or missing ResourceTypeDatabase.Read. |