Microsoft Endpoint Configuration Management Dates API

Date dimension for time-based reporting.

Documentation

Specifications

Schemas & Data

Other Resources

OpenAPI Specification

microsoft-endpoint-configuration-management-dates-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Microsoft Endpoint Configuration Management Configuration Manager REST API (AdminService) Applications Dates API
  description: REST API for managing Configuration Manager resources including collections, deployments, applications, and device queries. The administration service is based on the OData v4 protocol and supports both WMI and versioned OData routes. Class names are case-sensitive.
  version: 1.0.0
  contact:
    name: Microsoft Configuration Manager Support
    url: https://learn.microsoft.com/en-us/intune/configmgr/develop/adminservice/overview
  license:
    name: Microsoft API License
    url: https://learn.microsoft.com/en-us/legal/microsoft-apis/terms-of-use
servers:
- url: https://{siteserver}/AdminService
  description: Configuration Manager AdminService endpoint
  variables:
    siteserver:
      default: smsproviderfqdn
      description: Fully qualified domain name of the SMS Provider server hosting the administration service.
security:
- windowsAuth: []
- oauth2: []
tags:
- name: Dates
  description: Date dimension for time-based reporting.
paths:
  /dates:
    get:
      operationId: listDates
      summary: Microsoft Endpoint Configuration Management List date dimension records
      description: Retrieve date dimension records used to correlate facts over time dimensions. Provides date keys with associated calendar attributes.
      tags:
      - Dates
      parameters:
      - $ref: '#/components/parameters/apiVersion'
      - $ref: '#/components/parameters/top'
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/select'
      responses:
        '200':
          description: Successful response returning date records.
          content:
            application/json:
              schema:
                type: object
                properties:
                  value:
                    type: array
                    items:
                      $ref: '#/components/schemas/DateEntity'
components:
  schemas:
    DateEntity:
      type: object
      description: Date dimension entity used to correlate facts over time.
      properties:
        dateKey:
          type: integer
          description: Unique identifier for the date in YYYYMMDD format.
        fullDate:
          type: string
          format: date
          description: Full date representation.
        dayOfWeek:
          type: integer
          description: Day of the week (1=Sunday, 7=Saturday).
        dayOfMonth:
          type: integer
          description: Day of the month.
        dayOfYear:
          type: integer
          description: Day of the year.
        weekOfYear:
          type: integer
          description: Week of the year.
        monthOfYear:
          type: integer
          description: Month of the year.
        calendarQuarter:
          type: integer
          description: Calendar quarter.
        calendarYear:
          type: integer
          description: Calendar year.
  parameters:
    select:
      name: $select
      in: query
      description: Comma-separated list of properties to include.
      schema:
        type: string
    filter:
      name: $filter
      in: query
      description: OData filter expression. Only DateKey or RowLastModifiedDateTimeUTC may be supported for filtering depending on the collection.
      schema:
        type: string
    apiVersion:
      name: api-version
      in: query
      required: true
      description: API version. Use 'v1.0' for stable or 'beta' for preview features.
      schema:
        type: string
        enum:
        - v1.0
        - beta
        default: v1.0
    top:
      name: $top
      in: query
      description: Number of items to return.
      schema:
        type: integer
  securitySchemes:
    windowsAuth:
      type: http
      scheme: negotiate
      description: Windows Integrated Authentication (Kerberos/NTLM).
    oauth2:
      type: oauth2
      description: OAuth 2.0 via Azure AD for cloud management gateway access.
      flows:
        authorizationCode:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
          scopes: {}