🖥️
LoadFAST: Technical Documentation
  • LoadFAST: Technical Documentation
  • SETTING UP
    • Prepare
      • Prerequisites
        • Set up Power BI and Azure
        • Set up PowerShell
        • Register the resource providers
      • Pre-deployment
        • Create an app registration for the LoadFAST API
        • Set up and configure the Power BI tenant settings
    • Deploy
      • Deploy automatically via Azure Marketplace
    • Configure
      • Add the redirect URIs
      • Grant admin-level privileges on Azure SQL database
      • Execute the PowerShell Script in Windows PowerShell ISE
      • Assign admin roles in the application
      • Insight report
  • Resources
    • LoadFAST architecture
    • API Documentation
      • API reference
        • TestRunExecutionDetails
          • CreateTestRunExecution
          • CreateTestRunExecutionNonBulk
          • GetTestRunExecutionDetails
          • GetTestRunExecutionDetailsByCollectionId
        • AdminSetting
          • GetInsightsReportConfig
          • UpdateInsightsReportConfig
          • GetCapacityReportConfig
          • UpdateCapacityReportConfig
        • AppOwnsInfo
          • InsertAppOwnsAccessToken
        • AzureKeyVault
          • GetSecret
        • Collections
          • CreateCollection
          • UpdateCollection
          • DeleteCollection
          • GetCollectionById
          • GetCollections
          • GetCollectionNames
          • UpdateFavouriteCollection
          • GetCollectionsOptimized
          • UpdateCollectionName
          • GetCollectionsLazy
          • NewTestClick
          • CollectionCollaborator
        • CreateTableConfig
          • CreateTable
        • Embed
          • EmbedTokenSave
          • GetEmbedInfo
          • GetRLSEmbedInfo
          • GetEmbedInfoForWorkspace
          • GetAADToken
          • GetAllUserAADToken
        • Kubernetes
          • GetKubernetesClusterStatus
          • GetKubernetesClustersInResourceGroup
          • StartKubernetesCluster
          • StopKubernetesCluster
          • ScaleUpNodePool
          • UpdateKubernetesClusterStatus
          • UpdatePLTKubeConfigField
          • GetKubernetesResource
          • GETInactivityState
          • UpdateInactivityState
          • UpdateInactivityStateAndHours
          • UpdateClusterStartTime
          • GetLoadCount
          • UpdateLoadCount
          • UpdateLoadCountMultiRegion
          • GetLoadCountMultiRegion
          • GETInactivityStateMultiRegion
          • UpdateInactivityStateMultiRegion
          • UpdateInactivityStateAndHoursMultiRegion
          • UpdateClusterStartTimeMultiRegion
        • Api
          • KubernetesExploration
        • Notifications
          • GetLastClusterNotification
          • AddNotification
          • GetNotifications
          • DeleteNotifications
        • RLS
          • GetRLSRoles
        • TestRun
          • CreateTestRun
          • DeleteTestRun
          • GetTestRunsByCollectionId
          • GetTestRun
          • GetAllTestRuns
          • GetAllTestRunsOfSpecificAccess
          • GetAllTestRunsOfSpecificAccessLazyLoading
        • UserInfo
          • UserId
          • RegisterNewUser
          • UpdateAccessToken
    • Cost details
    • Security/Privacy policy
Powered by GitBook
On this page
  1. Resources
  2. API Documentation
  3. API reference
  4. Collections

GetCollectionById

PreviousDeleteCollectionNextGetCollections

Retrieves a collection and its associated collaborators by the given collection ID.

get
Authorizations
Query parameters
collectionIdinteger · int32Required

The ID of the collection to retrieve.

Responses
200
Success: The collection and its collaborators were successfully retrieved.
400
Bad Request: The provided collection ID is invalid.
404
Not Found: No collection was found with the provided collection ID.
500
Internal Server Error: An error occurred while retrieving the collection or collaborators.
get
GET /Collections/GetCollectionById?collectionId=1 HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content