Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MdmAnnotationResource

Controller: annotation | POST | /api/${catalogueItemDomainType}/${catalogueItemId}/annotations/${annotationId}/annotations | Action: save | GET | /api/${catalogueItemDomainType}/${catalogueItemId}/annotations/${annotationId}/annotations | Action: index | DELETE | /api/${catalogueItemDomainType}/${catalogueItemId}/annotations/${annotationId}/annotations/${id} | Action: delete | GET | /api/${catalogueItemDomainType}/${catalogueItemId}/annotations/${annotationId}/annotations/${id} | Action: show | POST | /api/${catalogueItemDomainType}/${catalogueItemId}/annotations | Action: save | GET | /api/${catalogueItemDomainType}/${catalogueItemId}/annotations | Action: index | DELETE | /api/${catalogueItemDomainType}/${catalogueItemId}/annotations/${id} | Action: delete | GET | /api/${catalogueItemDomainType}/${catalogueItemId}/annotations/${id} | Action: show

Hierarchy

Index

Constructors

Properties

Methods

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

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

getChild

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

listChildren

remove

removeChild

save

  • save(catalogueItemDomainType: string, catalogueItemId: string, data: any, restHandlerOptions?: IMdmRestHandlerOptions): any

saveChildren

  • saveChildren(catalogueItemDomainType: string, catalogueItemId: string, annotationId: string, data: any, restHandlerOptions?: IMdmRestHandlerOptions): any

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

Generated using TypeDoc