Options
All
  • Public
  • Public/Protected
  • All
Menu

Controller: dataModel | GET | /api/dataModels/providers/defaultDataTypeProviders | Action: defaultDataTypeProviders | GET | /api/dataModels/providers/importers | Action: importerProviders | GET | /api/dataModels/providers/exporters | Action: exporterProviders | GET | /api/dataModels/types | Action: types | POST | /api/dataModels/import/${importerNamespace}/${importerName}/${importerVersion} | Action: importModels | POST | /api/dataModels/export/${exporterNamespace}/${exporterName}/${exporterVersion} | Action: exportModels | DELETE | /api/dataModels/${dataModelId}/dataClasses/clean | Action: deleteAllUnusedDataClasses | DELETE | /api/dataModels/${dataModelId}/dataTypes/clean | Action: deleteAllUnusedDataTypes | GET | /api/folders/${folderId}/dataModels | Action: index | DELETE | /api/dataModels/${dataModelId}/readByAuthenticated | Action: readByAuthenticated | PUT | /api/dataModels/${dataModelId}/readByAuthenticated | Action: readByAuthenticated | DELETE | /api/dataModels/${dataModelId}/readByEveryone | Action: readByEveryone | PUT | /api/dataModels/${dataModelId}/readByEveryone | Action: readByEveryone | GET | /api/dataModels/${dataModelId}/search | Action: search | POST | /api/dataModels/${dataModelId}/search | Action: search | GET | /api/dataModels/${dataModelId}/hierarchy | Action: hierarchy | PUT | /api/dataModels/${dataModelId}/newModelVersion | Action: newModelVersion | PUT | /api/dataModels/${dataModelId}/newDocumentationVersion | Action: newDocumentationVersion | PUT | /api/dataModels/${dataModelId}/finalise | Action: finalise | POST | /api/folders/${folderId}/dataModels | Action: save | PUT | /api/folders/${folderId}/dataModels/${dataModelId} | Action: changeFolder | PUT | /api/dataModels/${dataModelId}/folder/${folderId} | Action: changeFolder | GET | /api/dataModels/${dataModelId}/suggestLinks/${otherModelId} | Action: suggestLinks | GET | /api/dataModels/${dataModelId}/diff/${otherModelId} | Action: diff | GET | /api/dataModels/${dataModelId}/export/${exporterNamespace}/${exporterName}/${exporterVersion} | Action: exportModel | GET | /api/dataModels | Action: index | DELETE | /api/dataModels | Action: deleteAll | DELETE | /api/dataModels/${id} | Action: delete | PUT | /api/dataModels/${id} | Action: update | GET | /api/dataModels/${id} | Action: show | PUT | /api/dataModels/${dataModelId}/newBranchModelVersion | Action: newBranchModelVersion | PUT | /api/dataModels/${dataModelId}/newForkModel | Action: newForkModel | GET | /api/dataModels/${dataModelId}/latestModelVersion | Action: latestModelVersion | GET | /api/dataModels/${dataModelId}/latestFinalisedModel | Action: latestFinalisedModel | GET | /api/dataModels/${dataModelId}/modelVersionTree | Action: modelVersionTree

Hierarchy

Index

Constructors

constructor

Properties

Protected apiEndpoint

apiEndpoint: string

Stores the base API endpoint for all REST requests.

Protected defaultRequestOptions

defaultRequestOptions: IMdmDefaultHttpRequestOptions

Stores the default options to apply to every REST request.

Methods

addToFolder

defaultDataTypes

diff

exportModel

exportModels

  • exportModels(exporterNamespace: any, exporterName: any, exporterVersion: any, data: any, restHandlerOptions?: IMdmRestHandlerOptions): any

exporters

finalise

Protected generateQueryString

  • Generate a query string for a URL based on object property values provided.

    Parameters

    • queryStringParams: IMdmQueryStringParams = ...

      A query string parameters object to convert to a string.

    Returns string

    A URL encoded string containing each parameter and value, or an empty string if no properties were provided.

get

hierarchy

importModels

  • importModels(importerNamespace: any, importerName: any, importerVersion: any, data: any, restHandlerOptions?: IMdmRestHandlerOptions): any

importers

Protected isGuid

  • isGuid(value: any): boolean
  • Test if a string represents a UUID.

    Parameters

    • value: any

      The string to test.

    Returns boolean

    True if value represents a UUID.

latestFinalisedModel

latestModelVersion

list

listInFolder

modelVersionTree

moveDataModelToFolder

  • moveDataModelToFolder(dataModelId: string, folderId: string, data: any, restHandlerOptions?: IMdmRestHandlerOptions): any

newBranchModelVersion

newDocumentationVersion

newForkModel

newModelVersion

remove

removeAll

removeAllUnusedDataClasses

removeAllUnusedDataTypes

removeReadByAuthenticated

removeReadByEveryone

search

simpleDelete

simpleGet

simplePost

  • Send a HTTP POST request to the given resource.

    Parameters

    • url: string

      The full URL to the REST resource.

    • data: any

      The data to include in the POST request body.

    • Optional options: IMdmRestHandlerOptions

      Optional REST handler options, if required.

    Returns any

    The result of the POST request.

simplePut

  • Send a HTTP PUT request to the given resource.

    Parameters

    • url: string

      The full URL to the REST resource.

    • data: any

      The data to include in the PUT request body.

    • Optional options: IMdmRestHandlerOptions

      Optional REST handler options, if required.

    Returns any

    The result of the PUT request.

simpleRequest

  • Send a generic HTTP request to the given resource.

    Parameters

    • url: string

      The full URL to the REST resource.

    • queryStringParams: IMdmQueryStringParams = ...

      Optional query string parameters, if required.

    • Optional options: IMdmRestHandlerOptions

      Optional REST handler options, if required.

    Returns any

    The result of the request.

    All details of HTTP request must be included in the options parameter, particularly the HTTP method:

    simpleRequest('http://localhost/api/test', { }, { method: 'GET' });
    

suggestLinks

types

update

updateDataModelInFolder

  • updateDataModelInFolder(folderId: string, dataModelId: string, data: any, restHandlerOptions?: IMdmRestHandlerOptions): any

updateReadByAuthenticated

updateReadByEveryone

Generated using TypeDoc