Xeonr Developer Docs
UplApiIntegrations

Resolve resource integrations

POST
/uplim.api.v1.IntegrationsService/ResolveResourceIntegrations

Resolves renderer and open-with options for an upload or folder by matching against integration content types, or for the bucket itself when no target is given. integration_id makes one installed integration the renderer for the call (its archive, its tokens) without recording a default; at bucket scope that is its bucket-scoped renderer. An integration that is not installed on the bucket, or has no renderer for the target, is refused with FailedPrecondition.

Authorization

OAuth2 upl:bucket:read
AuthorizationBearer <token>

OAuth 2.0 authorization

In: header

Scope: upl:bucket:read

Header Parameters

Connect-Protocol-Version?number

Define the version of the Connect protocol

Connect-Timeout-Ms?number

Define the timeout, in ms

Request Body

application/json

bucketRef?&
integrationId?string|null

Makes this integration the resolved renderer for this call only: the response's renderer, renderer_integration and both access tokens are for its archive and its client. No default is recorded (SetDefaultOpenWith does that), and open_with, default_application and default_unset are as without it.

With a target, the renderer is the integration's highest-priority content type that matches the resource and has a renderer. With no target (the bucket itself), it is the integration's bucket-scoped renderer: the bucket type's when the integration is this bucket's type, otherwise the first of its bucket types with a renderer; the integration access token then reaches the whole bucket, as a bucket type renderer's does.

The integration must be installed on the bucket (an active installation), be the bucket's own type or the target's owning integration, or be the system Default; otherwise FailedPrecondition. FailedPrecondition too when it has no renderer for the target, or none at bucket scope.

Formatuuid
folderRef?&

Response Body

application/json

application/json

curl -X POST "https://uploads-api.xeonr.io/uplim.api.v1.IntegrationsService/ResolveResourceIntegrations" \  -H "Connect-Protocol-Version: 1" \  -H "Connect-Timeout-Ms: 1000" \  -H "Content-Type: application/json" \  -d '{}'
{
  "rendererIntegration": {
    "integrationId": "string",
    "oauthClientId": "string",
    "oauthApplicationId": "6e68418e-eaad-4fd1-af9d-e9521eee4cbc",
    "name": "string",
    "apiKeyEnabled": true,
    "scoping": "string",
    "contentTypes": [
      {
        "id": "string",
        "integrationId": "string",
        "criteria": {
          "kinds": [
            "CONTENT_TARGET_KIND_UNSPECIFIED"
          ]
        },
        "renderer": {
          "enabled": true,
          "archiveUploadId": "0f00a816-1fc2-4597-bbce-ea7af713750b",
          "entryPath": "string"
        },
        "openWith": {
          "enabled": true,
          "callbackUrl": "http://example.com"
        },
        "priority": 0,
        "createdAt": "2023-01-15T01:30:15.01Z",
        "updatedAt": "2023-01-15T01:30:15.01Z",
        "name": "string",
        "displayLabel": "string",
        "iconName": "string",
        "matcher": "string",
        "matcherPriority": 0,
        "iconUploadId": "string",
        "worker": {
          "enabled": true,
          "archiveUploadId": "0f00a816-1fc2-4597-bbce-ea7af713750b",
          "entryPath": "string"
        }
      }
    ],
    "defaultBucketTypeId": "9b1c8916-4239-4e84-b4d2-0740320b30d9",
    "newFiles": [
      {
        "id": "string",
        "integrationId": "string",
        "name": "string",
        "extension": "string",
        "creationType": "NEW_FILE_CREATION_TYPE_UNSPECIFIED",
        "defaultContent": {
          "multiple": {
            "files": {
              "property1": {
                "stringContent": "string"
              },
              "property2": {
                "stringContent": "string"
              }
            }
          }
        },
        "contentTypeId": "string",
        "createdAt": "2023-01-15T01:30:15.01Z",
        "updatedAt": "2023-01-15T01:30:15.01Z"
      }
    ],
    "metadataKeys": [
      {
        "id": "string",
        "integrationId": "string",
        "key": "string",
        "title": "string",
        "iconName": "string",
        "valueType": "METADATA_VALUE_TYPE_UNSPECIFIED",
        "hiddenFromUsers": true,
        "createdAt": "2023-01-15T01:30:15.01Z",
        "updatedAt": "2023-01-15T01:30:15.01Z"
      }
    ],
    "folderBehavior": "INTEGRATION_FOLDER_BEHAVIOR_UNSPECIFIED",
    "folderLinkUrl": "http://example.com",
    "mode": "INTEGRATION_MODE_UNSPECIFIED",
    "bucketLauncherEnabled": true,
    "slug": "string",
    "isSystem": true,
    "systemManagedClient": true,
    "discoverable": true,
    "ownerTeam": "string",
    "ownerTeamSlug": "string",
    "createdAt": "2023-01-15T01:30:15.01Z",
    "updatedAt": "2023-01-15T01:30:15.01Z"
  },
  "renderer": {
    "enabled": true,
    "archiveUploadId": "0f00a816-1fc2-4597-bbce-ea7af713750b",
    "entryPath": "string"
  },
  "openWith": [
    {
      "integration": {
        "integrationId": "string",
        "oauthClientId": "string",
        "oauthApplicationId": "6e68418e-eaad-4fd1-af9d-e9521eee4cbc",
        "name": "string",
        "apiKeyEnabled": true,
        "scoping": "string",
        "contentTypes": [
          {
            "id": "string",
            "integrationId": "string",
            "criteria": {
              "kinds": [
                "CONTENT_TARGET_KIND_UNSPECIFIED"
              ]
            },
            "renderer": {
              "enabled": true,
              "archiveUploadId": "0f00a816-1fc2-4597-bbce-ea7af713750b",
              "entryPath": "string"
            },
            "openWith": {
              "enabled": true,
              "callbackUrl": "http://example.com"
            },
            "priority": 0,
            "createdAt": "2023-01-15T01:30:15.01Z",
            "updatedAt": "2023-01-15T01:30:15.01Z",
            "name": "string",
            "displayLabel": "string",
            "iconName": "string",
            "matcher": "string",
            "matcherPriority": 0,
            "iconUploadId": "string",
            "worker": {
              "enabled": true,
              "archiveUploadId": "0f00a816-1fc2-4597-bbce-ea7af713750b",
              "entryPath": "string"
            }
          }
        ],
        "defaultBucketTypeId": "9b1c8916-4239-4e84-b4d2-0740320b30d9",
        "newFiles": [
          {
            "id": "string",
            "integrationId": "string",
            "name": "string",
            "extension": "string",
            "creationType": "NEW_FILE_CREATION_TYPE_UNSPECIFIED",
            "defaultContent": {
              "multiple": {
                "files": {
                  "property1": {
                    "stringContent": "string"
                  },
                  "property2": {
                    "stringContent": "string"
                  }
                }
              }
            },
            "contentTypeId": "string",
            "createdAt": "2023-01-15T01:30:15.01Z",
            "updatedAt": "2023-01-15T01:30:15.01Z"
          }
        ],
        "metadataKeys": [
          {
            "id": "string",
            "integrationId": "string",
            "key": "string",
            "title": "string",
            "iconName": "string",
            "valueType": "METADATA_VALUE_TYPE_UNSPECIFIED",
            "hiddenFromUsers": true,
            "createdAt": "2023-01-15T01:30:15.01Z",
            "updatedAt": "2023-01-15T01:30:15.01Z"
          }
        ],
        "folderBehavior": "INTEGRATION_FOLDER_BEHAVIOR_UNSPECIFIED",
        "folderLinkUrl": "http://example.com",
        "mode": "INTEGRATION_MODE_UNSPECIFIED",
        "bucketLauncherEnabled": true,
        "slug": "string",
        "isSystem": true,
        "systemManagedClient": true,
        "discoverable": true,
        "ownerTeam": "string",
        "ownerTeamSlug": "string",
        "createdAt": "2023-01-15T01:30:15.01Z",
        "updatedAt": "2023-01-15T01:30:15.01Z"
      },
      "contentType": {
        "id": "string",
        "integrationId": "string",
        "criteria": {
          "kinds": [
            "CONTENT_TARGET_KIND_UNSPECIFIED"
          ]
        },
        "renderer": {
          "enabled": true,
          "archiveUploadId": "0f00a816-1fc2-4597-bbce-ea7af713750b",
          "entryPath": "string"
        },
        "openWith": {
          "enabled": true,
          "callbackUrl": "http://example.com"
        },
        "priority": 0,
        "createdAt": "2023-01-15T01:30:15.01Z",
        "updatedAt": "2023-01-15T01:30:15.01Z",
        "name": "string",
        "displayLabel": "string",
        "iconName": "string",
        "matcher": "string",
        "matcherPriority": 0,
        "iconUploadId": "string",
        "worker": {
          "enabled": true,
          "archiveUploadId": "0f00a816-1fc2-4597-bbce-ea7af713750b",
          "entryPath": "string"
        }
      },
      "enabledForUser": true,
      "bestMatch": true,
      "launchUrl": "string",
      "reason": "string"
    }
  ],
  "rendererAccessToken": "string",
  "rendererAccessTokenExpiresAt": "2023-01-15T01:30:15.01Z",
  "integrationAccessToken": "string",
  "integrationAccessTokenExpiresAt": "2023-01-15T01:30:15.01Z",
  "defaultApplication": {
    "integration": {
      "integrationId": "string",
      "oauthClientId": "string",
      "oauthApplicationId": "6e68418e-eaad-4fd1-af9d-e9521eee4cbc",
      "name": "string",
      "apiKeyEnabled": true,
      "scoping": "string",
      "contentTypes": [
        {
          "id": "string",
          "integrationId": "string",
          "criteria": {
            "kinds": [
              "CONTENT_TARGET_KIND_UNSPECIFIED"
            ]
          },
          "renderer": {
            "enabled": true,
            "archiveUploadId": "0f00a816-1fc2-4597-bbce-ea7af713750b",
            "entryPath": "string"
          },
          "openWith": {
            "enabled": true,
            "callbackUrl": "http://example.com"
          },
          "priority": 0,
          "createdAt": "2023-01-15T01:30:15.01Z",
          "updatedAt": "2023-01-15T01:30:15.01Z",
          "name": "string",
          "displayLabel": "string",
          "iconName": "string",
          "matcher": "string",
          "matcherPriority": 0,
          "iconUploadId": "string",
          "worker": {
            "enabled": true,
            "archiveUploadId": "0f00a816-1fc2-4597-bbce-ea7af713750b",
            "entryPath": "string"
          }
        }
      ],
      "defaultBucketTypeId": "9b1c8916-4239-4e84-b4d2-0740320b30d9",
      "newFiles": [
        {
          "id": "string",
          "integrationId": "string",
          "name": "string",
          "extension": "string",
          "creationType": "NEW_FILE_CREATION_TYPE_UNSPECIFIED",
          "defaultContent": {
            "multiple": {
              "files": {
                "property1": {
                  "stringContent": "string"
                },
                "property2": {
                  "stringContent": "string"
                }
              }
            }
          },
          "contentTypeId": "string",
          "createdAt": "2023-01-15T01:30:15.01Z",
          "updatedAt": "2023-01-15T01:30:15.01Z"
        }
      ],
      "metadataKeys": [
        {
          "id": "string",
          "integrationId": "string",
          "key": "string",
          "title": "string",
          "iconName": "string",
          "valueType": "METADATA_VALUE_TYPE_UNSPECIFIED",
          "hiddenFromUsers": true,
          "createdAt": "2023-01-15T01:30:15.01Z",
          "updatedAt": "2023-01-15T01:30:15.01Z"
        }
      ],
      "folderBehavior": "INTEGRATION_FOLDER_BEHAVIOR_UNSPECIFIED",
      "folderLinkUrl": "http://example.com",
      "mode": "INTEGRATION_MODE_UNSPECIFIED",
      "bucketLauncherEnabled": true,
      "slug": "string",
      "isSystem": true,
      "systemManagedClient": true,
      "discoverable": true,
      "ownerTeam": "string",
      "ownerTeamSlug": "string",
      "createdAt": "2023-01-15T01:30:15.01Z",
      "updatedAt": "2023-01-15T01:30:15.01Z"
    },
    "contentType": {
      "id": "string",
      "integrationId": "string",
      "criteria": {
        "kinds": [
          "CONTENT_TARGET_KIND_UNSPECIFIED"
        ]
      },
      "renderer": {
        "enabled": true,
        "archiveUploadId": "0f00a816-1fc2-4597-bbce-ea7af713750b",
        "entryPath": "string"
      },
      "openWith": {
        "enabled": true,
        "callbackUrl": "http://example.com"
      },
      "priority": 0,
      "createdAt": "2023-01-15T01:30:15.01Z",
      "updatedAt": "2023-01-15T01:30:15.01Z",
      "name": "string",
      "displayLabel": "string",
      "iconName": "string",
      "matcher": "string",
      "matcherPriority": 0,
      "iconUploadId": "string",
      "worker": {
        "enabled": true,
        "archiveUploadId": "0f00a816-1fc2-4597-bbce-ea7af713750b",
        "entryPath": "string"
      }
    },
    "enabledForUser": true,
    "bestMatch": true,
    "launchUrl": "string",
    "reason": "string"
  },
  "defaultUnset": true,
  "rendererContentTypeId": "73ccf9d9-7f23-4fb5-ba47-80fd8e468239"
}
{
  "code": "not_found",
  "message": "string",
  "details": [
    {
      "type": "string",
      "value": "string",
      "debug": {}
    }
  ]
}