Appfire

Appfire Period Alias Resource API

The period-alias-resource API from Appfire — 5 operation(s) for period-alias-resource.

GitHub OpenAPI

Operations 7

GET /api/v2/periodAlias Get available aliases #
POST /api/v2/periodAlias Create alias #
POST /api/v2/periodAlias/{aliasId} Edit custom alias 1 #
DELETE /api/v2/periodAlias/{aliasId} Delete alias #
POST /api/v2/periodAlias/{aliasId}/updateVisibility Change visibility of provided alias #
GET /api/v2/periodAlias/{periodId}/usage Get period usage #
GET /api/v2/periodAlias/all Get all aliases #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/appfire/refs/heads/main/openapi/appfire-period-alias-resource-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/appfire:appfire-period-alias-resource-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

appfire-period-alias-resource-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: OpenAPI definition Period Alias Resource API
  version: v0
servers:
- url: http://okr-ppm-prod.appfire.com
  description: Generated server url
tags:
- name: period-alias-resource
paths:
  /api/v2/periodAlias:
    get:
      tags:
      - period-alias-resource
      operationId: getAvailableAliases
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PeriodAlias'
      summary: Get available aliases
      x-summary-source: derived
    post:
      tags:
      - period-alias-resource
      operationId: createAlias
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PeriodAliasInputBean'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      summary: Create alias
      x-summary-source: derived
  /api/v2/periodAlias/{aliasId}:
    post:
      tags:
      - period-alias-resource
      operationId: editCustomAlias_1
      parameters:
      - name: aliasId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PeriodAliasInputBean'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      summary: Edit custom alias 1
      x-summary-source: derived
    delete:
      tags:
      - period-alias-resource
      operationId: deleteAlias
      parameters:
      - name: aliasId
        in: path
        required: true
        schema:
          type: string
      - name: replacementPeriodId
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      summary: Delete alias
      x-summary-source: derived
  /api/v2/periodAlias/{aliasId}/updateVisibility:
    post:
      tags:
      - period-alias-resource
      operationId: changeVisibilityOfProvidedAlias
      parameters:
      - name: aliasId
        in: path
        required: true
        schema:
          type: string
      - name: visible
        in: query
        required: true
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      summary: Change visibility of provided alias
      x-summary-source: derived
  /api/v2/periodAlias/{periodId}/usage:
    get:
      tags:
      - period-alias-resource
      operationId: getPeriodUsage
      parameters:
      - name: periodId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: object
      summary: Get period usage
      x-summary-source: derived
  /api/v2/periodAlias/all:
    get:
      tags:
      - period-alias-resource
      operationId: getAllAliases
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PeriodAlias'
      summary: Get all aliases
      x-summary-source: derived
components:
  schemas:
    PeriodAliasInputBean:
      type: object
      properties:
        name:
          type: string
        startDate:
          type: string
          format: date-time
        deadline:
          type: string
          format: date-time
      required:
      - name
    PeriodAlias:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        startDate:
          type: string
          format: date-time
        deadline:
          type: string
          format: date-time
        appProvided:
          type: boolean
        hidden:
          type: boolean
      required:
      - deadline
      - name
      - startDate
x-provenance:
  method: harvested
  publisher: Appfire
  source: https://okr-ppm-prod.appfire.com/v3/api-docs
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)