Custom assets

This REST API is used to manage custom assets. You can define an asset type and add assets of the defined type.

List of resources

  • POST /types

    Creates a custom asset type with the given details.

  • GET /types/ticket

    Retrieves the details of the specified custom asset type.

  • GET /types

    Retrieves the list of custom asset types in Developer Portal.

  • POST /types/search

    Searches for an asset type based on the given search criteria.

  • PUT /types/ticket

    Updates the specified custom asset type with the given details.

  • PUT /types/ticket/fields/Issue_details_doc

    Provides the given value as the default value for the specified asset type property.

  • PUT /types/ticket/fields/Issue_screenshot

    Provides the given image as the default image for the specified asset type property.

  • GET /types/_count

    Retrieves the number of asset types added in Developer Portal.

  • DELETE /types/{id}
    Deletes the specified asset type.
    Note: To delete an inactive or obsolete asset type, make a REST call to the following endpoint:
    DELETE  /types/{id}?force=true

    with the required application Id:

  • POST /types/ticket/instances

    Creates an asset of the specified asset type.

  • GET /types/feature/instances/{id}

    Retrieves the details of the specified asset.

  • GET /types/feature/instances

    Retrieves all assets of the specified asset type.

  • POST /types/ticket/instances/search

    Retrieves the details of assets matching the given search keyword.

  • PUT /types/ticket/instances/{id}

    Updates the specified asset with the given details.

  • PUT /types/ticket/instances/{id}/fields/Issue_details_doc

    Uploads the given file for the specified file field.

  • PUT /types/ticket/instances/{id}/fields/Issue_screenshot

    Uploads the given image file for the specified image field. .

  • PUT /types/ticket/instances/{id}/logo

    Uploads the given logo for the specified asset.

  • GET /types/ticket/instances/_count

    Retrieves the number of assets for the specified asset type.

  • GET /types/ticket/instances/{id}/topics

    Retrieves the list of topics for the given asset.

  • PUT /types/ticket/instances/{id}/followers

    Subscribes or unsubscribes to receive the updates of the given asset.

  • GET /types/ticket/instances/{id}/followers

    Retrieves the list of followers of the specified asset.

  • GET /types/ticket/instances/{id}/followers/_count

    Retrieves the number of followers of the specified asset.

  • GET /types/ticket/instances/{id}/bookmarks

    Retrives the list of topics of the specified asset that are saved as bookmarks.

  • DEL /types/ticket/instances/{id}

    Deletes the specified asset.

  • PUT /types/{id}/rate

    Allows to provide a rating for the specified asset.

Sample cURL Command

curl --location --request GET 'developer_portal_rest_base/types' \
--header 'Authorization: Basic basic_auth'

The typedefinition.yaml file is located at InstallDir\DeveloperPortal\developers\openapis.