SAP BI Tools Content Items API

Manage content items in the Content Network including retrieving, publishing, and deleting both private and public content packages.

Documentation

Specifications

Other Resources

OpenAPI Specification

sap-bi-tools-content-items-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: SAP BI Tools SAP Analytics Cloud Administration Content Items API
  description: RESTful API for SAP Analytics Cloud enabling programmatic access to system data stored on an SAP Analytics Cloud tenant. The API provides endpoints for managing stories, models, users, teams, calendars, and other resources. It supports SCIM 2.0 for user provisioning, OData for data access, and standard REST patterns for content management. Authentication uses OAuth 2.0 with SAML bearer assertion or authorization code grant flows.
  version: '1.0'
  contact:
    name: SAP Support
    url: https://support.sap.com/en/index.html
  termsOfService: https://www.sap.com/about/legal/terms-of-use.html
servers:
- url: https://{tenant}.{datacenter}.sapanalytics.cloud
  description: SAP Analytics Cloud Tenant
  variables:
    tenant:
      default: my-tenant
      description: The SAP Analytics Cloud tenant name
    datacenter:
      default: eu1
      description: The data center region (e.g., eu1, eu10, us1, us10, ap1)
security:
- oauth2: []
tags:
- name: Content Items
  description: Manage content items in the Content Network including retrieving, publishing, and deleting both private and public content packages.
paths:
  /api/v1/contentnetwork/items:
    get:
      operationId: listContentItems
      summary: SAP BI Tools List content items
      description: Retrieves a list of content items available in the Content Network. Returns both private and public content items with their metadata including name, description, type, and version information.
      tags:
      - Content Items
      parameters:
      - name: type
        in: query
        description: Filter by content item type (e.g., STORY, MODEL, PACKAGE)
        schema:
          type: string
      - name: visibility
        in: query
        description: Filter by visibility (PRIVATE or PUBLIC)
        schema:
          type: string
          enum:
          - PRIVATE
          - PUBLIC
      responses:
        '200':
          description: Successfully retrieved list of content items
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ContentItem'
        '401':
          description: Unauthorized - invalid or missing authentication token
    post:
      operationId: publishContentItem
      summary: SAP BI Tools Publish a content item
      description: Publishes a content item to the Content Network making it available for other tenants to discover and import. The content item is packaged with its dependencies and metadata.
      tags:
      - Content Items
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ContentItemPublish'
      responses:
        '201':
          description: Content item published successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentItem'
        '400':
          description: Bad request - invalid content item data
        '401':
          description: Unauthorized - invalid or missing authentication token
  /api/v1/contentnetwork/items/{itemId}:
    get:
      operationId: getContentItem
      summary: SAP BI Tools Get a content item by ID
      description: Retrieves detailed information about a specific content item from the Content Network identified by its unique item ID.
      tags:
      - Content Items
      parameters:
      - $ref: '#/components/parameters/ItemIdParam'
      responses:
        '200':
          description: Successfully retrieved content item details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ContentItem'
        '401':
          description: Unauthorized - invalid or missing authentication token
        '404':
          description: Content item not found
    delete:
      operationId: deleteContentItem
      summary: SAP BI Tools Delete a content item
      description: Deletes a content item from the Content Network. Only private content items owned by the current tenant can be deleted.
      tags:
      - Content Items
      parameters:
      - $ref: '#/components/parameters/ItemIdParam'
      responses:
        '204':
          description: Content item deleted successfully
        '401':
          description: Unauthorized - invalid or missing authentication token
        '403':
          description: Forbidden - insufficient permissions to delete
        '404':
          description: Content item not found
components:
  parameters:
    ItemIdParam:
      name: itemId
      in: path
      required: true
      description: The unique identifier of the content item
      schema:
        type: string
  schemas:
    ContentItemPublish:
      type: object
      description: Request body for publishing a content item
      required:
      - name
      - resourceId
      properties:
        name:
          type: string
          description: The display name for the published content item
        description:
          type: string
          description: A description of the content item
        resourceId:
          type: string
          description: The ID of the local resource to publish
        visibility:
          type: string
          description: The visibility scope for the published item
          enum:
          - PRIVATE
          - PUBLIC
          default: PRIVATE
    ContentItem:
      type: object
      description: Represents a content item in the SAP Analytics Cloud Content Network. Content items are shareable artifacts such as stories, models, and packages.
      properties:
        id:
          type: string
          description: The unique identifier of the content item
        name:
          type: string
          description: The display name of the content item
        description:
          type: string
          description: A text description of the content item
        type:
          type: string
          description: The type of content item (e.g., STORY, MODEL, PACKAGE)
        visibility:
          type: string
          description: The visibility scope (PRIVATE or PUBLIC)
          enum:
          - PRIVATE
          - PUBLIC
        version:
          type: string
          description: The version of the content item
        createdTime:
          type: string
          format: date-time
          description: The timestamp when the item was published
        modifiedTime:
          type: string
          format: date-time
          description: The timestamp when the item was last modified
        owner:
          type: string
          description: The tenant that published the content item
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 authentication using SAML bearer assertion or authorization code grant flow.
      flows:
        authorizationCode:
          authorizationUrl: https://{tenant}.authentication.{region}.hana.ondemand.com/oauth/authorize
          tokenUrl: https://{tenant}.authentication.{region}.hana.ondemand.com/oauth/token
          scopes: {}
externalDocs:
  description: SAP Analytics Cloud REST API Documentation
  url: https://help.sap.com/docs/SAP_ANALYTICS_CLOUD/14cac91febef464dbb1efce20e3f1613/3ccfab3348dd407db089accb66cff9a2.html