Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MdmDataFlowResource

Controller: dataFlow | GET | /api/dataFlows/providers/importers | Action: importerProviders | GET | /api/dataFlows/providers/exporters | Action: exporterProviders | POST | /api/dataFlows/import/${importerNamespace}/${importerName}/${importerVersion} | Action: importDataFlows | POST | /api/dataFlows/export/${exporterNamespace}/${exporterName}/${exporterVersion} | Action: exportDataFlows | PUT | /api/dataModels/${dataModelId}/dataFlows/${dataFlowId}/diagramLayout | Action: updateDiagramLayout | POST | /api/dataModels/${dataModelId}/dataFlows/${dataFlowId}/import/${importerNamespace}/${importerName}/${importerVersion} | Action: importDataFlow | GET | /api/dataModels/${dataModelId}/dataFlows/${dataFlowId}/export/${exporterNamespace}/${exporterName}/${exporterVersion} | Action: exportDataFlow | POST | /api/dataModels/${dataModelId}/dataFlows | Action: save | GET | /api/dataModels/${dataModelId}/dataFlows | Action: index | DELETE | /api/dataModels/${dataModelId}/dataFlows/${id} | Action: delete | PUT | /api/dataModels/${dataModelId}/dataFlows/${id} | Action: update | GET | /api/dataModels/${dataModelId}/dataFlows/${id} | Action: show

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected apiEndpoint

apiEndpoint: string

Stores the base API endpoint for all REST requests.

dataClassComponents

dataClassComponents: MdmDataClassComponentResource

dataElementComponents

dataElementComponents: MdmDataElementComponentResource

Protected defaultRequestOptions

defaultRequestOptions: IMdmDefaultHttpRequestOptions

Stores the default options to apply to every REST request.

Methods

exportDataFlow

  • exportDataFlow(dataModelId: string, dataFlowId: string, importerNamespace: any, importerName: any, importerVersion: any, queryStringParams?: IMdmQueryStringParams, restHandlerOptions?: IMdmRestHandlerOptions): any

exportDataFlows

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

exporters

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

importDataFlow

  • importDataFlow(dataModelId: string, dataFlowId: string, importerNamespace: any, importerName: any, importerVersion: any, data: any, restHandlerOptions?: IMdmRestHandlerOptions): any

importDataFlows

  • importDataFlows(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.

list

remove

save

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

update

  • update(dataModelId: string, dataFlowId: string, data: any, restHandlerOptions?: IMdmRestHandlerOptions): any

updateDiagramLayout

  • updateDiagramLayout(dataModelId: string, dataFlowId: string, data: any, restHandlerOptions?: IMdmRestHandlerOptions): any

Generated using TypeDoc