Options
All
  • Public
  • Public/Protected
  • All
Menu

Controller: codeSet | GET | /api/codeSets/providers/importers | Action: importerProviders | | GET | /api/codeSets/providers/exporters | Action: exporterProviders | | POST | /api/codeSets/import/${importerNamespace}/${importerName}/${importerVersion} | Action: importModels | | POST | /api/codeSets/export/${exporterNamespace}/${exporterName}/${exporterVersion} | Action: exportModels | | DELETE | /api/codeSets/${codeSetId}/readByAuthenticated | Action: readByAuthenticated | | PUT | /api/codeSets/${codeSetId}/readByAuthenticated | Action: readByAuthenticated | | DELETE | /api/codeSets/${codeSetId}/readByEveryone | Action: readByEveryone | | PUT | /api/codeSets/${codeSetId}/readByEveryone | Action: readByEveryone | | PUT | /api/codeSets/${codeSetId}/newModelVersion | Action: newModelVersion | | PUT | /api/codeSets/${codeSetId}/newDocumentationVersion | Action: newDocumentationVersion | | PUT | /api/codeSets/${codeSetId}/finalise | Action: finalise | | POST | /api/folders/${folderId}/codeSets | Action: save | | GET | /api/folders/${folderId}/codeSets | Action: index | | DELETE | /api/codeSets/${codeSetId}/terms/${termId} | Action: alterTerms | | PUT | /api/codeSets/${codeSetId}/terms/${termId} | Action: alterTerms | | PUT | /api/codeSets/${codeSetId}/folder/${folderId} | Action: changeFolder | | GET | /api/codeSets/${codeSetId}/diff/${otherModelId} | Action: diff | | PUT | /api/folders/${folderId}/codeSets/${codeSetId} | Action: changeFolder | | GET | /api/codeSets/${codeSetId}/export/${exporterNamespace}/${exporterName}/${exporterVersion} | Action: exportModel | | GET | /api/codeSets | Action: index | | DELETE | /api/codeSets | Action: deleteAll | | DELETE | /api/codeSets/${id} | Action: delete | | PUT | /api/codeSets/${id} | Action: update | | GET | /api/codeSets/${id} | Action: show | | PUT | /api/codeSets/${codeSetId}/newBranchModelVersion | Action: newBranchModelVersion | | PUT | /api/codeSets/${codeSetId}/newForkModel | Action: newForkModel | | GET | /api/codeSets/${codeSetId}/latestModelVersion | Action: latestModelVersion | | GET | /api/codeSets/${codeSetId}/latestFinalisedModel | Action: latestFinalisedModel | | GET | /api/codeSets/${codeSetId}/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

addCodeSetsToFolder

alterTerm

diff

exportModel

exportModels

  • exportModels(namespace: any, name: any, version: 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

importModels

  • importModels(namespace: any, name: any, version: 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

listCodeSetsInFolder

modelVersionTree

moveCodeSetToFolder

  • moveCodeSetToFolder(codeSetId: string, folderId: string, data: any, restHandlerOptions?: IMdmRestHandlerOptions): any

newBranchModelVersion

newDocumentationVersion

newForkModel

newModelVersion

remove

removeAll

removeReadByAuthenticated

removeReadByEveryone

removeTerm

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' });
    

terms

update

updateReadByAuthenticated

updateReadByEveryone

Generated using TypeDoc