Submitting License Usage Report

In this article

    You can submit a license usage report.

    Request

    POST https://<hostname>:4443/v6/licensing/reports/{reportId}/approve

    Request Headers

    The request header must contain an authorization token of the current session.

    Request Parameters

    The following parameter must be specified in the URL of the request:

    Parameter

    Type

    Description

    reportId

    string

    Specifies the identification number of the license usage report. For more information on how to get this parameter, see Viewing License Usage Report.

    Request Body

    If you want to remove a number of users from the report, the the request body must contain the following properties:

    Property

    Type

    Description

    organizationId

    string

    Specifies the identification number of an organization whose users you want to remove from the report.

    removedUsersCount

    integer

    Specifies the number of organization users removed from the report.

    removalReason

    string

    Specifies the reason for removal of users from the report.

    For example:

    {

     "removedUsers": [

       {

         "organizationId": "a7f96a33-06cc-44a7-8219-5d1d16214184",

         "removedUsersCount": 2,

         "removalReason": "These were test users."

       }

     ]

    }

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns a response code 200 OK.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the response body message: application/json; charset=utf-8

    Response Body

    None.

    Example

    The example shows how to submit a license usage report.

    Request:

    POST https://abc.tech.local:4443/v6/licensing/reports/0/approve

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK