POST/projects/api/v3/reporting/views/{type}.json

Create a new reporting view.

Create a new reporting view for the given type.

Path Params

  • Name
    type
    Type
    integer
    required
    Description

Body Params

Request is the payload used to create or update a reporting view. The Config field carries the raw settings blob and is passed through unparsed; it is validated against the per-type JSON Schema in the service layer. Name, DisplayOrder, IsVisible and IsPinned are pointers so create/update handlers can tell an omitted field ("leave unchanged" on PATCH, default on POST) apart from a zero value.

    • Name
      config
      Type
      string
    • Name
      displayOrder
      Type
      number
    • Name
      grantAccessTo
      Type
      object
      Description
      GrantAccessTo lists who the reporting view is shared with. Collections are always emitted, as empty arrays when nobody of that kind has a grant.
    • Name
      isPinned
      Type
      boolean
    • Name
      isVisible
      Type
      boolean
    • Name
      name
      Type
      string
    • Name
      visibility
      Type
      string

    Responses

    • Code
      201
      Type
      object
      Schema
      Description
      201 Created
      Response contains information about a specific reporting view.
    • Code
      400
      Type
      object
      Schema
      Description
      400 Bad Request
      ErrorResponse defines how []Error should be marshaled to JSON.
    • Code
      404
      Description
      404 Not Found No Data
    • Code
      413
      Type
      object
      Schema
      Description
      413 Request Entity Too Large
      ErrorResponse defines how []Error should be marshaled to JSON.

    Examples

    201 Created

    Response
    {
  "view": {
    "config": "string",
    "createdAt": "string",
    "createdBy": 0,
    "displayOrder": 0,
    "grantAccessTo": {
      "companies": [
        {
          "grant": "string",
          "id": 0
        }
      ],
      "teams": [
        {
          "grant": "string",
          "id": 0
        }
      ],
      "users": [
        {
          "grant": "string",
          "id": 0
        }
      ]
    },
    "id": 0,
    "isPinned": true,
    "isVisible": true,
    "name": "string",
    "type": "string",
    "updatedAt": "string",
    "updatedBy": 0,
    "visibility": "string"
  }
}
    Download Swagger