Interface ITemplateDefinitionsClient

interface ITemplateDefinitionsClient {
    getTemplateDefinitionById(args: {
        culture?: null | string;
        repoId: string;
        select?: null | string;
        templateId: number;
    }): Promise<WTemplateInfo>;
    getTemplateDefinitions(args: {
        count?: boolean;
        culture?: null | string;
        orderby?: null | string;
        prefer?: null | string;
        repoId: string;
        select?: null | string;
        skip?: number;
        templateName?: null | string;
        top?: number;
    }): Promise<ODataValueContextOfIListOfWTemplateInfo>;
    getTemplateDefinitionsForEach(args: {
        callback: ((response: ODataValueContextOfIListOfWTemplateInfo) => Promise<boolean>);
        count?: boolean;
        culture?: string;
        maxPageSize?: number;
        orderby?: string;
        prefer?: string;
        repoId: string;
        select?: string;
        skip?: number;
        templateName?: string;
        top?: number;
    }): Promise<void>;
    getTemplateDefinitionsNextLink(args: {
        maxPageSize?: number;
        nextLink: string;
    }): Promise<ODataValueContextOfIListOfWTemplateInfo>;
    getTemplateFieldDefinitions(args: {
        count?: boolean;
        culture?: null | string;
        orderby?: null | string;
        prefer?: null | string;
        repoId: string;
        select?: null | string;
        skip?: number;
        templateId: number;
        top?: number;
    }): Promise<ODataValueContextOfIListOfTemplateFieldInfo>;
    getTemplateFieldDefinitionsByTemplateName(args: {
        count?: boolean;
        culture?: null | string;
        orderby?: null | string;
        prefer?: null | string;
        repoId: string;
        select?: null | string;
        skip?: number;
        templateName: null | string;
        top?: number;
    }): Promise<ODataValueContextOfIListOfTemplateFieldInfo>;
    getTemplateFieldDefinitionsByTemplateNameForEach(args: {
        callback: ((response: ODataValueContextOfIListOfTemplateFieldInfo) => Promise<boolean>);
        count?: boolean;
        culture?: string;
        maxPageSize?: number;
        orderby?: string;
        prefer?: string;
        repoId: string;
        select?: string;
        skip?: number;
        templateName: string;
        top?: number;
    }): Promise<void>;
    getTemplateFieldDefinitionsByTemplateNameNextLink(args: {
        maxPageSize?: number;
        nextLink: string;
    }): Promise<ODataValueContextOfIListOfTemplateFieldInfo>;
    getTemplateFieldDefinitionsForEach(args: {
        callback: ((response: ODataValueContextOfIListOfTemplateFieldInfo) => Promise<boolean>);
        count?: boolean;
        culture?: string;
        maxPageSize?: number;
        orderby?: string;
        prefer?: string;
        repoId: string;
        select?: string;
        skip?: number;
        templateId: number;
        top?: number;
    }): Promise<void>;
    getTemplateFieldDefinitionsNextLink(args: {
        maxPageSize?: number;
        nextLink: string;
    }): Promise<ODataValueContextOfIListOfTemplateFieldInfo>;
}

Implemented by

Methods

getTemplateDefinitionById getTemplateDefinitions getTemplateDefinitionsForEach getTemplateDefinitionsNextLink getTemplateFieldDefinitions getTemplateFieldDefinitionsByTemplateName getTemplateFieldDefinitionsByTemplateNameForEach getTemplateFieldDefinitionsByTemplateNameNextLink getTemplateFieldDefinitionsForEach getTemplateFieldDefinitionsNextLink

Methods

getTemplateDefinitionById

  • getTemplateDefinitionById(args): Promise<WTemplateInfo>
    • Returns a single template definition (including field definitions, if relevant).
    • Provide a template definition ID, and get the single template definition associated with that ID. Useful when a route provides a minimal amount of details, and more information about the specific template is needed.
    • Allowed OData query options: Select

    Parameters

    • args: {
          culture?: null | string;
          repoId: string;
          select?: null | string;
          templateId: number;
      }
      • Optionalculture?: null | string

        (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.

      • repoId: string

        The requested repository ID.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

      • templateId: number

        The requested template definition ID.

    Returns Promise<WTemplateInfo>

    Get template definition successfully.

getTemplateDefinitions

  • getTemplateDefinitions(args): Promise<ODataValueContextOfIListOfWTemplateInfo>
    • Returns all template definitions (including field definitions) in the repository. If a template name query parameter is given, then a single template definition is returned.
    • Provide a repository ID, and get a paged listing of template definitions available in the repository. Useful when trying to find a list of all template definitions available, rather than a specific one.
    • Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.

    Parameters

    • args: {
          count?: boolean;
          culture?: null | string;
          orderby?: null | string;
          prefer?: null | string;
          repoId: string;
          select?: null | string;
          skip?: number;
          templateName?: null | string;
          top?: number;
      }
      • Optionalcount?: boolean

        (optional) Indicates whether the total count of items within a collection are returned in the result.

      • Optionalculture?: null | string

        (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.

      • Optionalorderby?: null | string

        (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.

      • Optionalprefer?: null | string

        (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.

      • repoId: string

        The requested repository ID.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

      • Optionalskip?: number

        (optional) Excludes the specified number of items of the queried collection from the result.

      • OptionaltemplateName?: null | string

        (optional) An optional query parameter. Can be used to get a single template definition using the template name.

      • Optionaltop?: number

        (optional) Limits the number of items returned from a collection.

    Returns Promise<ODataValueContextOfIListOfWTemplateInfo>

    Get template definitions successfully.

getTemplateDefinitionsForEach

  • getTemplateDefinitionsForEach(args): Promise<void>

  • It will continue to make the same call to get a list of template definitions of a fixed size (i.e. maxpagesize) until it reaches the last page (i.e. when next link is null/undefined) or whenever the callback function returns false.

    Parameters

    • args: {
          callback: ((response: ODataValueContextOfIListOfWTemplateInfo) => Promise<boolean>);
          count?: boolean;
          culture?: string;
          maxPageSize?: number;
          orderby?: string;
          prefer?: string;
          repoId: string;
          select?: string;
          skip?: number;
          templateName?: string;
          top?: number;
      }
      • callback: ((response: ODataValueContextOfIListOfWTemplateInfo) => Promise<boolean>)

        async callback function that will accept the current page results and return a boolean value to either continue or stop paging.

      • Optionalcount?: boolean

        (optional) Indicates whether the total count of items within a collection are returned in the result.

      • Optionalculture?: string

        (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting.

      • OptionalmaxPageSize?: number

        (optional) the maximum page size or number of template definitions allowed per API response schema.

      • Optionalorderby?: string

        (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.

      • Optionalprefer?: string

        (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.

      • repoId: string

        The requested repository ID.

      • Optionalselect?: string

        (optional) Limits the properties returned in the result.

      • Optionalskip?: number

        (optional) Excludes the specified number of items of the queried collection from the result.

      • OptionaltemplateName?: string

        (optional) An optional query parameter. Can be used to get a single template definition using the template name.

      • Optionaltop?: number

        (optional) Limits the number of items returned from a collection.

    Returns Promise<void>

getTemplateDefinitionsNextLink

  • getTemplateDefinitionsNextLink(args): Promise<ODataValueContextOfIListOfWTemplateInfo>

  • Returns all template definitions (including field definitions) in the repository using a next link

    Parameters

    • args: {
          maxPageSize?: number;
          nextLink: string;
      }
      • OptionalmaxPageSize?: number

        (optional) the maximum page size or number of template definitions allowed per API response schema

      • nextLink: string

        a url that allows retrieving the next subset of the requested collection

    Returns Promise<ODataValueContextOfIListOfWTemplateInfo>

    Get template definitions with the next link successfully

getTemplateFieldDefinitions

  • getTemplateFieldDefinitions(args): Promise<ODataValueContextOfIListOfTemplateFieldInfo>
    • Returns the field definitions assigned to a template definition.
    • Provide a template definition ID, and get a paged listing of the field definitions assigned to that template.
    • Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.

    Parameters

    • args: {
          count?: boolean;
          culture?: null | string;
          orderby?: null | string;
          prefer?: null | string;
          repoId: string;
          select?: null | string;
          skip?: number;
          templateId: number;
          top?: number;
      }
      • Optionalcount?: boolean

        (optional) Indicates whether the total count of items within a collection are returned in the result.

      • Optionalculture?: null | string

        (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.

      • Optionalorderby?: null | string

        (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.

      • Optionalprefer?: null | string

        (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.

      • repoId: string

        The requested repository ID.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

      • Optionalskip?: number

        (optional) Excludes the specified number of items of the queried collection from the result.

      • templateId: number

        The requested template definition ID.

      • Optionaltop?: number

        (optional) Limits the number of items returned from a collection.

    Returns Promise<ODataValueContextOfIListOfTemplateFieldInfo>

    Get template field definitions successfully.

getTemplateFieldDefinitionsByTemplateName

  • getTemplateFieldDefinitionsByTemplateName(args): Promise<ODataValueContextOfIListOfTemplateFieldInfo>
    • Returns the field definitions assigned to a template definition.
    • Provide a template definition name, and get a paged listing of the field definitions assigned to that template.
    • Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.

    Parameters

    • args: {
          count?: boolean;
          culture?: null | string;
          orderby?: null | string;
          prefer?: null | string;
          repoId: string;
          select?: null | string;
          skip?: number;
          templateName: null | string;
          top?: number;
      }
      • Optionalcount?: boolean

        (optional) Indicates whether the total count of items within a collection are returned in the result.

      • Optionalculture?: null | string

        (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.

      • Optionalorderby?: null | string

        (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.

      • Optionalprefer?: null | string

        (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.

      • repoId: string

        The requested repository ID.

      • Optionalselect?: null | string

        (optional) Limits the properties returned in the result.

      • Optionalskip?: number

        (optional) Excludes the specified number of items of the queried collection from the result.

      • templateName: null | string

        A required query parameter for the requested template name.

      • Optionaltop?: number

        (optional) Limits the number of items returned from a collection.

    Returns Promise<ODataValueContextOfIListOfTemplateFieldInfo>

    Get template field definitions successfully.

getTemplateFieldDefinitionsByTemplateNameForEach

  • getTemplateFieldDefinitionsByTemplateNameForEach(args): Promise<void>

  • It will continue to make the same call to get a list of template field definitions by template name of a fixed size (i.e. maxpagesize) until it reaches the last page (i.e. when next link is null/undefined) or whenever the callback function returns false.

    Parameters

    • args: {
          callback: ((response: ODataValueContextOfIListOfTemplateFieldInfo) => Promise<boolean>);
          count?: boolean;
          culture?: string;
          maxPageSize?: number;
          orderby?: string;
          prefer?: string;
          repoId: string;
          select?: string;
          skip?: number;
          templateName: string;
          top?: number;
      }
      • callback: ((response: ODataValueContextOfIListOfTemplateFieldInfo) => Promise<boolean>)

        async callback function that will accept the current page results and return a boolean value to either continue or stop paging.

      • Optionalcount?: boolean

        (optional) Indicates whether the total count of items within a collection are returned in the result.

      • Optionalculture?: string

        (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting.

      • OptionalmaxPageSize?: number

        (optional) the maximum page size or number of template field definitions by template name allowed per API response schema.

      • Optionalorderby?: string

        (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.

      • Optionalprefer?: string

        (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.

      • repoId: string

        The requested repository ID.

      • Optionalselect?: string

        (optional) Limits the properties returned in the result.

      • Optionalskip?: number

        (optional) Excludes the specified number of items of the queried collection from the result.

      • templateName: string

        (optional) An optional query parameter. Can be used to get a single template definition using the template name.

      • Optionaltop?: number

        (optional) Limits the number of items returned from a collection.

    Returns Promise<void>

getTemplateFieldDefinitionsByTemplateNameNextLink

  • getTemplateFieldDefinitionsByTemplateNameNextLink(args): Promise<ODataValueContextOfIListOfTemplateFieldInfo>

  • Returns the field definitions assigned to a template definition by template name using a next link

    Parameters

    • args: {
          maxPageSize?: number;
          nextLink: string;
      }
      • OptionalmaxPageSize?: number

        (optional) the maximum page size or number of template field definitions by template name allowed per API response schema

      • nextLink: string

        a url that allows retrieving the next subset of the requested collection

    Returns Promise<ODataValueContextOfIListOfTemplateFieldInfo>

    Get field definitions by template name with the next link successfully

getTemplateFieldDefinitionsForEach

  • getTemplateFieldDefinitionsForEach(args): Promise<void>

  • It will continue to make the same call to get a list of template field definitions of a fixed size (i.e. maxpagesize) until it reaches the last page (i.e. when next link is null/undefined) or whenever the callback function returns false.

    Parameters

    • args: {
          callback: ((response: ODataValueContextOfIListOfTemplateFieldInfo) => Promise<boolean>);
          count?: boolean;
          culture?: string;
          maxPageSize?: number;
          orderby?: string;
          prefer?: string;
          repoId: string;
          select?: string;
          skip?: number;
          templateId: number;
          top?: number;
      }
      • callback: ((response: ODataValueContextOfIListOfTemplateFieldInfo) => Promise<boolean>)

        async callback function that will accept the current page results and return a boolean value to either continue or stop paging.

      • Optionalcount?: boolean

        (optional) Indicates whether the total count of items within a collection are returned in the result.

      • Optionalculture?: string

        (optional) An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting.

      • OptionalmaxPageSize?: number

        (optional) the maximum page size or number of template field definitions allowed per API response schema.

      • Optionalorderby?: string

        (optional) Specifies the order in which items are returned. The maximum number of expressions is 5.

      • Optionalprefer?: string

        (optional) An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.

      • repoId: string

        The requested repository ID.

      • Optionalselect?: string

        (optional) Limits the properties returned in the result.

      • Optionalskip?: number

        (optional) Excludes the specified number of items of the queried collection from the result.

      • templateId: number
      • Optionaltop?: number

        (optional) Limits the number of items returned from a collection.

    Returns Promise<void>

getTemplateFieldDefinitionsNextLink

Settings

Member Visibility

On This Page

Methods