Variable AdminApiConst

AdminApi: {
    apiV2AdminOptions(options?): AxiosPromise<void>;
    getAllActivityLogs(requestParameters?, options?): AxiosPromise<ActivityLogDtoPagedResponse>;
    getAllProjects(requestParameters?, options?): AxiosPromise<ProjectAdminDtoPagedResponse>;
    getAllResources(requestParameters?, options?): AxiosPromise<ResourceAdminDtoPagedResponse>;
    getAllUsers(requestParameters?, options?): AxiosPromise<UserDtoPagedResponse>;
    getMetadataGraph(requestParameters, options?): AxiosPromise<RdfDefinitionDtoResponse>;
    patchMetadata(requestParameters, options?): AxiosPromise<void>;
    updateMetadataGraph(requestParameters, options?): AxiosPromise<void>;
} = apis.AdminApi

Type declaration

  • apiV2AdminOptions:function
    • Parameters

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<void>

      Summary

      Responds with the HTTP methods allowed for the endpoint.

      Throws

  • getAllActivityLogs:function
    • Required JWT roles for access: administrator.

      Parameters

      • requestParameters: AdminApiGetAllActivityLogsRequest = {}

        Request parameters.

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<ActivityLogDtoPagedResponse>

      Summary

      Retrieves all activity logs.

      Throws

  • getAllProjects:function
    • Required JWT roles for access: administrator.

      Parameters

      • requestParameters: AdminApiGetAllProjectsRequest = {}

        Request parameters.

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<ProjectAdminDtoPagedResponse>

      Summary

      Retrieves all projects.

      Throws

  • getAllResources:function
    • Required JWT roles for access: administrator.

      Parameters

      • requestParameters: AdminApiGetAllResourcesRequest = {}

        Request parameters.

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<ResourceAdminDtoPagedResponse>

      Summary

      Retrieves all resources.

      Throws

  • getAllUsers:function
    • Required JWT roles for access: administrator.

      Parameters

      • requestParameters: AdminApiGetAllUsersRequest = {}

        Request parameters.

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<UserDtoPagedResponse>

      Summary

      Retrieves all users.

      Throws

  • getMetadataGraph:function
    • Required JWT roles for access: administrator.

      Parameters

      • requestParameters: AdminApiGetMetadataGraphRequest

        Request parameters.

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<RdfDefinitionDtoResponse>

      Summary

      Gets a metadata graph.

      Throws

  • patchMetadata:function
    • Required JWT roles for access: administrator.

      Parameters

      • requestParameters: AdminApiPatchMetadataRequest

        Request parameters.

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<void>

      Summary

      Patches a metadata graph.

      Throws

  • updateMetadataGraph:function
    • Required JWT roles for access: administrator.

      Parameters

      • requestParameters: AdminApiUpdateMetadataGraphRequest

        Request parameters.

      • Optional options: AxiosRequestConfig<any>

        Override http request option.

      Returns AxiosPromise<void>

      Summary

      Updates a metadata graph.

      Throws

Generated using TypeDoc