Skip to content

Latest commit

 

History

History
293 lines (190 loc) · 7.58 KB

PeriodoApi.md

File metadata and controls

293 lines (190 loc) · 7.58 KB
Raw

SwaggerJsClient.PeriodoApi

All URIs are relative to /

Method HTTP request Description
deletePeriodoItem DELETE /api/periodos/{id} Removes the Periodo resource.
getPeriodoCollection GET /api/periodos Retrieves the collection of Periodo resources.
getPeriodoItem GET /api/periodos/{id} Retrieves a Periodo resource.
patchPeriodoItem PATCH /api/periodos/{id} Updates the Periodo resource.
postPeriodoCollection POST /api/periodos Creates a Periodo resource.
putPeriodoItem PUT /api/periodos/{id} Replaces the Periodo resource.

deletePeriodoItem

deletePeriodoItem(id)

Removes the Periodo resource.

Removes the Periodo resource.

Example

import { SwaggerJsClient } from "swagger-js-client";

let apiInstance = new SwaggerJsClient.PeriodoApi();
let id = "id_example"; // String | Resource identifier

apiInstance.deletePeriodoItem(id, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log("API called successfully.");
  }
});

Parameters

Name Type Description Notes
id String Resource identifier

Return type

null (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getPeriodoCollection

InlineResponse20012 getPeriodoCollection(opts)

Retrieves the collection of Periodo resources.

Retrieves the collection of Periodo resources.

Example

import { SwaggerJsClient } from "swagger-js-client";

let apiInstance = new SwaggerJsClient.PeriodoApi();
let opts = {
  page: 1, // Number | The collection page number
};
apiInstance.getPeriodoCollection(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log("API called successfully. Returned data: " + data);
  }
});

Parameters

Name Type Description Notes
page Number The collection page number [optional] [default to 1]

Return type

InlineResponse20012

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/ld+json, application/json, text/html

getPeriodoItem

PeriodoJsonld getPeriodoItem(id)

Retrieves a Periodo resource.

Retrieves a Periodo resource.

Example

import { SwaggerJsClient } from "swagger-js-client";

let apiInstance = new SwaggerJsClient.PeriodoApi();
let id = "id_example"; // String | Resource identifier

apiInstance.getPeriodoItem(id, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log("API called successfully. Returned data: " + data);
  }
});

Parameters

Name Type Description Notes
id String Resource identifier

Return type

PeriodoJsonld

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/ld+json, application/json, text/html

patchPeriodoItem

PeriodoJsonld patchPeriodoItem(body, id)

Updates the Periodo resource.

Updates the Periodo resource.

Example

import { SwaggerJsClient } from "swagger-js-client";

let apiInstance = new SwaggerJsClient.PeriodoApi();
let body = new SwaggerJsClient.Periodo(); // Periodo | The updated Periodo resource
let id = "id_example"; // String | Resource identifier

apiInstance.patchPeriodoItem(body, id, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log("API called successfully. Returned data: " + data);
  }
});

Parameters

Name Type Description Notes
body Periodo The updated Periodo resource
id String Resource identifier

Return type

PeriodoJsonld

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/merge-patch+json
  • Accept: application/ld+json, application/json, text/html

postPeriodoCollection

PeriodoJsonld postPeriodoCollection(body)

Creates a Periodo resource.

Creates a Periodo resource.

Example

import { SwaggerJsClient } from "swagger-js-client";

let apiInstance = new SwaggerJsClient.PeriodoApi();
let body = new SwaggerJsClient.PeriodoJsonld(); // PeriodoJsonld | The new Periodo resource

apiInstance.postPeriodoCollection(body, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log("API called successfully. Returned data: " + data);
  }
});

Parameters

Name Type Description Notes
body PeriodoJsonld The new Periodo resource

Return type

PeriodoJsonld

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/ld+json, application/json, text/html
  • Accept: application/ld+json, application/json, text/html

putPeriodoItem

PeriodoJsonld putPeriodoItem(body, id)

Replaces the Periodo resource.

Replaces the Periodo resource.

Example

import { SwaggerJsClient } from "swagger-js-client";

let apiInstance = new SwaggerJsClient.PeriodoApi();
let body = new SwaggerJsClient.PeriodoJsonld(); // PeriodoJsonld | The updated Periodo resource
let id = "id_example"; // String | Resource identifier

apiInstance.putPeriodoItem(body, id, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log("API called successfully. Returned data: " + data);
  }
});

Parameters

Name Type Description Notes
body PeriodoJsonld The updated Periodo resource
id String Resource identifier

Return type

PeriodoJsonld

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/ld+json, application/json, text/html
  • Accept: application/ld+json, application/json, text/html