The OC core API is a low-level collection of APIs that allows the direct interaction with the individual micro services via REST and OData for querying
Please click here to access the OC Core API documentation
{
"openapi": "3.0.1",
"info": {
"title": "Utilities API v1.0",
"description": "Genetec Operations Center",
"version": "v1.0"
},
"paths": {
"/v1/changelogs": {
"get": {
"tags": [
"Changelogs"
],
"operationId": "Get",
"parameters": [
{
"name": "number",
"in": "query",
"schema": {
"type": "integer",
"format": "int32",
"default": 100
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ChangelogViewModel"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangelogViewModel"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ChangelogViewModel"
}
}
}
},
"default": {
"description": "Error",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/v1/combguid": {
"get": {
"tags": [
"CombGuid"
],
"operationId": "GetSingle",
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"application/json": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"text/json": {
"schema": {
"type": "string",
"format": "uuid"
}
}
}
},
"default": {
"description": "Error",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/v1/combguid/batch/{batchSize}": {
"get": {
"tags": [
"CombGuid"
],
"operationId": "GetBatch",
"parameters": [
{
"name": "batchSize",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/plain": {
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"type": "string",
"format": "uuid"
}
}
}
}
},
"default": {
"description": "Error",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"ChangelogEntryViewModel": {
"type": "object",
"properties": {
"title": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
},
"body": {
"type": "string",
"nullable": true
},
"html": {
"type": "string",
"nullable": true
},
"createdAt": {
"type": "string",
"format": "date-time"
}
},
"additionalProperties": false
},
"ChangelogViewModel": {
"type": "object",
"properties": {
"entries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChangelogEntryViewModel"
},
"nullable": true
}
},
"additionalProperties": false
},
"ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
}
},
"securitySchemes": {
"GenetecSts": {
"type": "oauth2",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://login.genetec.com/connect/authorize",
"tokenUrl": "https://login.genetec.com/connect/token",
"scopes": {
"openid": "",
"profile": "",
"groups": "",
"source_iss": "",
"oc.services": "",
"sso.provisioning": ""
}
}
}
}
}
}
}