openapi: 3.0.0
info:
  title: Secret Server Rest Activations Schedule API
  description: REST API documentation for Secret Server. This document describes how to use the REST API. All requests require an authentication token; please see the <a href="../OAuth/">authentication document</a> for more information. The <a href="swagger.json">Swagger specification</a> for this API is also available.
  termsOfService: https://delinea.com/eula
  contact:
    name: Support
    url: https://delinea.com
  version: 11.7.2
servers:
- url: /SecretServer/api
security:
- BearerToken: []
tags:
- name: Schedule
  description: ScheduleController
paths:
  /v1/schedules/{scheduleId}:
    get:
      tags:
      - Schedule
      summary: Recurring schedule
      description: Get all the details for a recurring schedule by ID
      operationId: ScheduleService_GetSchedule
      parameters:
      - name: scheduleId
        in: path
        description: scheduleId
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: The recurring schedule details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecurringScheduleModel'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
    patch:
      tags:
      - Schedule
      summary: Update a Recurring Schedule
      description: Update partial details for a recurring schedule or all constraints
      operationId: ScheduleService_UpdateSchedule
      parameters:
      - name: scheduleId
        in: path
        description: scheduleId
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecurringScheduleUpdateArgs'
        description: args
      responses:
        '200':
          description: The updated recurring schedule details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecurringScheduleModel'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
  /v1/schedules:
    post:
      tags:
      - Schedule
      summary: Create a Recurring Schedule
      description: Create a recurring schedule and all constraints
      operationId: ScheduleService_CreateSchedule
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RecurringScheduleCreateArgs'
        description: args
      responses:
        '200':
          description: The saved recurring schedule details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecurringScheduleModel'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestResponse'
        '403':
          description: Authentication failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationFailedResponse'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalServerErrorResponse'
      deprecated: false
components:
  schemas:
    UpdateFieldValueOfBoolean:
      description: Active
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: boolean
      type: object
    RecurringScheduleCreateArgs:
      description: RecurringScheduleCreateArgs
      properties:
        data:
          $ref: '#/components/schemas/RecurringScheduleCreateModel'
      type: object
    RecurringScheduleUpdateModel:
      description: Data
      properties:
        active:
          $ref: '#/components/schemas/UpdateFieldValueOfBoolean'
        duration:
          $ref: '#/components/schemas/UpdateFieldValueOfInt32'
        durationStartDate:
          $ref: '#/components/schemas/UpdateFieldValueOfDateTime'
        notes:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
        recurringScheduleId:
          description: Unique ID for this schedule
          type: integer
          format: int32
        recurringScheduleType:
          $ref: '#/components/schemas/UpdateFieldValueOfRecurringScheduleType'
        scheduleConstraints:
          $ref: '#/components/schemas/UpdateFieldValueOfRecurringScheduleValueModelArray'
        timeZoneId:
          $ref: '#/components/schemas/UpdateFieldValueOfString'
      type: object
    InternalServerErrorResponse:
      description: Response object for internal server errors
      required:
      - message
      - exceptionMessage
      - exceptionType
      - stackTrace
      properties:
        message:
          description: Error message
          type: string
        exceptionMessage:
          description: Error message from exception
          type: string
        exceptionType:
          description: Exception type
          type: string
        stackTrace:
          description: Exception stack trace
          type: string
      type: object
    RecurringScheduleValueType:
      description: The type of schedule constraint
      properties: {}
      type: string
      enum:
      - SpecificTime
      - DayOfWeek
      - DayOfMonth
      - WeekOfMonth
      - WeekOfMonthDay
    UpdateFieldValueOfInt32:
      description: How many days until the password expires.
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: integer
          format: int32
      type: object
    RecurringScheduleType:
      description: The iteration period for the schedule.  The schedule will restart after this cycle.
      properties: {}
      type: string
      enum:
      - Daily
      - Weekly
      - MonthlyDays
      - MonthlyWeeks
    BadRequestResponse:
      description: Response object for invalid requests
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
        messageDetail:
          description: Error message detail
          type: string
        errorCode:
          description: Error message code
          type: string
        modelState:
          description: An object describing validation errors
          type: object
      type: object
    UpdateFieldValueOfRecurringScheduleValueModelArray:
      description: Passing any constraints will update all of them and remove any not specified.
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          items:
            $ref: '#/components/schemas/RecurringScheduleValueModel'
          type: array
      type: object
    RecurringScheduleCreateModel:
      description: Data
      properties:
        active:
          description: Whether or not the schedule is active
          type: boolean
        duration:
          description: How long is the iteration of this schedule.  A weekly schedule with an iteration of 2 would restart every other week.
          type: integer
          format: int32
        durationStartDate:
          description: When does the schedule iteration begin
          type: string
          format: date-time
        entity:
          $ref: '#/components/schemas/RecurringScheduleEntityModel'
        notes:
          description: TBD
          type: string
        recurringScheduleType:
          $ref: '#/components/schemas/RecurringScheduleType'
        scheduleConstraints:
          description: Passing any constraints will update all of them and remove any not specified.
          items:
            $ref: '#/components/schemas/RecurringScheduleValueModel'
          type: array
        timeZoneId:
          description: Time Zone of the times the schedule is run
          type: string
      type: object
    UpdateFieldValueOfDateTime:
      description: BackupStartDateTime
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: string
          format: date-time
      type: object
    RecurringScheduleEntityModel:
      description: These are entities that subcribe to this schedule
      properties:
        entityId:
          description: The ID of the entity that is subscribing to this schedule
          type: integer
          format: int32
        entityType:
          $ref: '#/components/schemas/RecurringScheduleEntityType'
        id:
          description: The id of schedule entity map
          type: integer
          format: int32
      type: object
    RecurringScheduleModel:
      description: A recurring schedule defines an interval that can trigger tasks
      properties:
        active:
          description: Whether or not the schedule is active
          type: boolean
        duration:
          description: How long is the iteration of this schedule.  A weekly schedule with an iteration of 2 would restart every other week.
          type: integer
          format: int32
        durationStartDate:
          description: When does the schedule iteration begin
          type: string
          format: date-time
        entity:
          $ref: '#/components/schemas/RecurringScheduleEntityModel'
        notes:
          description: TBD
          type: string
        recurringScheduleId:
          description: Unique ID for this schedule
          type: integer
          format: int32
        recurringScheduleType:
          $ref: '#/components/schemas/RecurringScheduleType'
        scheduleConstraints:
          description: These indicate the rules for when a schedule should recur.  If all of the constraints are met then the schedule will trigger.
          items:
            $ref: '#/components/schemas/RecurringScheduleValueModel'
          type: array
        timeZoneId:
          description: Time Zone of the times the schedule is run
          type: string
      type: object
    UpdateFieldValueOfRecurringScheduleType:
      description: The iteration period for the schedule.  The schedule will restart after this cycle.
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          $ref: '#/components/schemas/RecurringScheduleType'
      type: object
    AuthenticationFailedResponse:
      description: Response object for authentication failures
      required:
      - message
      properties:
        message:
          description: Error message
          type: string
      type: object
    RecurringScheduleEntityType:
      description: This is the type of entity
      properties: {}
      type: string
      enum:
      - InboxRule
    RecurringScheduleUpdateArgs:
      description: RecurringScheduleUpdateArgs
      properties:
        data:
          $ref: '#/components/schemas/RecurringScheduleUpdateModel'
      type: object
    RecurringScheduleValueModel:
      description: A defined constraint for a schedule
      properties:
        recurrenceValue:
          description: The value that applies to the constraint.
          type: integer
          format: int32
        recurrenceValueType:
          $ref: '#/components/schemas/RecurringScheduleValueType'
      type: object
    UpdateFieldValueOfString:
      description: Description
      properties:
        dirty:
          description: Dirty
          type: boolean
        value:
          description: Value
          type: string
      type: object
  securitySchemes:
    BearerToken:
      type: apiKey
      description: 'Perform a POST request to `/oauth2/token`. It should include three form data parameters - `username`, `password`, and `grant_type`.The `grant_type` parameter should always have the value `password`.The access token returned should be included in the header of subsequent requests, like ''Authorization: Bearer <em>token</em>''. The token remains valid for a time period returned in the ''expires_in'' property (in seconds). For details, see the <a href="../OAuth/">token request documentation</a>.'
      name: Authorization
      in: header