Home Guides API reference What's New Developer Discussion
labels
filters (1) The following filters can be applied to the call. Filters may be chained together.
Filter Path Filter Parameter Data Type Parameter Description
labels
  • get
    post

    labels / count

    resource URL(s)

    • http://community.lithium.com/community-name/restapi/vc / categories / id / [id]  / labels / count

    returns

    int: the number of labels assigned to this message.

    example URLs

    • http://community.lithium.com/community-name/restapi/vc/categories/id/support/labels/count

    response

    show details
    <response status="success">
      <value type="int">32</value>
    </response>
    

  • get
    post

    labels / index / [index] 

    resource URL(s)

    • http://community.lithium.com/community-name/restapi/vc / categories / id / [id]  / labels / index / [index] 

    returns

    LiaEntity:

    path arguments

    Parameter Type Possible Values Description
    index int

    query arguments

    Parameter Type Possible Values Description
    page_size (optional) int The size of the page to be returned. When displaying threads, we recommend showing no more than 25 threads per page. Specify a number from 5 to 1000.
    page (optional) int The 1-based index of the page to be returned.
    nested.page (optional) int
    nested.page_size (optional) int

    example URLs

    • http://community.lithium.com/community-name/restapi/vc/categories/id/support/labels/index/index

    response

    show details
    <response status="success">
      <lia_entity type="lia_entity"/>
    </response>
    

  • get
    post

    labels / labels

    Returns a list of labels for this node at the page number indicated by the given page properties, and containing the number of items indicated by the page properties.

    resource URL(s)

    • http://community.lithium.com/community-name/restapi/vc / categories / id / [id]  / labels / labels

    returns

    LiaEntity list: a list of labels for this node, constrained by provided page range information

    query arguments

    Parameter Type Possible Values Description
    page_size (optional) int The size of the page to be returned. When displaying threads, we recommend showing no more than 25 threads per page. Specify a number from 5 to 1000.
    page (optional) int The 1-based index of the page to be returned.
    nested.page (optional) int
    nested.page_size (optional) int

    example URLs

    • http://community.lithium.com/community-name/restapi/vc/categories/id/support/labels/labels

    response

    show details
    <response status="success">
      <labels/>
    </response>