> ## Documentation Index > Fetch the complete documentation index at: https://docs.ridergy.com/llms.txt > Use this file to discover all available pages before exploring further. # Criar ou substituir um perfil de limite para toda a organização > Registra um perfil de limite máximo para toda a organização do tenant que está chamando (derivado da chave de API — sem `orgId` no caminho ou no corpo). > **Ainda não aplicado.** A aplicação do limite máximo em toda a > organização para os locais do tenant ainda não está ativa (Fase 3, > adiada). Os perfis são registrados apenas para uso futuro. ## OpenAPI ````yaml /api-reference/energy-management/openapi.pt.yaml POST /organizations/schedules openapi: 3.1.0 info: title: RiDERgy Energy Management API version: '1.0' license: name: Proprietary identifier: LicenseRef-Proprietary description: > Controle programático dos limites de potência de carregamento em locais, carregadores individuais, organizações e clusters entre locais. ## Autenticação Todos os endpoints, exceto `GET /health`, exigem um cabeçalho `x-api-key`. A chave determina o seu tenant — ela nunca é lida do corpo da requisição ou de qualquer outro cabeçalho, portanto uma chave de um tenant não pode acessar os dados de outro tenant. O seu tenant precisa ter o recurso Energy Management API habilitado, caso contrário as requisições falharão com `403 FEATURE_NOT_ENABLED`. Entre em contato com a RiDERgy para habilitá-lo. ## Modelo de prioridade Os limites de locais e carregadores são controlados por meio de **perfis com janelas de prioridade**: - As prioridades variam de **0 (mais baixa) a 10 (mais alta)**, no estilo da pilha OCPP. - Um alvo (local ou conector de carregador) pode ter até 11 perfis, um por nível de prioridade, cada um com sua própria janela `[startTime, endTime)`. - A qualquer momento, o **limite efetivo** é o `limitKw` do perfil de maior prioridade cuja janela esteja atualmente ativa. - Se nenhum perfil estiver ativo, um local volta a usar o seu `permanentLimitKw`. - O envio de um perfil em uma prioridade que já possui um perfil para esse alvo **substitui** o existente. - Os perfis são aplicados e revertidos automaticamente em seus horários `startTime`/`endTime` — não são necessárias chamadas adicionais à API após a criação de um perfil. Os registros de perfis nunca são excluídos, então o histórico permanece consultável. ## Erros Todos os erros compartilham este formato: ```json { "error": { "code": "LOCATION_NOT_FOUND", "message": "Location 123 was not found for the provided tenant", "requestId": "b1f6e6b0-..." } } ``` servers: - url: https://api.ridergy.com/v1 description: Production security: - ApiKeyAuth: [] tags: - name: Health description: Verificação de integridade do serviço sem autenticação. - name: Locations description: >- Leia e defina limites de potência em nível de local e perfis de prioridade. - name: Chargers description: >- Trave conectores de carregadores individuais em um limite de potência fixo durante uma janela de tempo. - name: Organizations description: >- Perfis de limite máximo em toda a organização (apenas registrados — a aplicação ainda não está ativa). - name: Clusters description: >- Agrupe locais sob um limite de kW compartilhado e aplique cronogramas entre eles. paths: /organizations/schedules: post: tags: - Organizations summary: Create or replace an organization-wide cap profile description: | Registra um perfil de limite máximo para toda a organização do tenant que está chamando (derivado da chave de API — sem `orgId` no caminho ou no corpo). > **Ainda não aplicado.** A aplicação do limite máximo em toda a > organização para os locais do tenant ainda não está ativa (Fase 3, > adiada). Os perfis são registrados apenas para uso futuro. operationId: createOrganizationSchedule requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LimitProfileRequest' examples: example: value: startTime: '2026-06-12T08:00:00Z' endTime: '2026-06-12T18:00:00Z' limitKw: 500 priority: 5 responses: '200': description: Perfil da organização criado/substituído content: application/json: schema: $ref: '#/components/schemas/OrgScheduleResponse' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/FeatureNotEnabled' components: schemas: LimitProfileRequest: type: object required: - startTime - endTime - limitKw properties: startTime: type: string format: date-time description: Timestamp ISO-8601 UTC. Obrigatório. example: '2026-06-12T08:00:00Z' endTime: type: string format: date-time description: >- Timestamp ISO-8601 UTC. Deve ser posterior a `startTime` e estar no futuro. Obrigatório. example: '2026-06-12T18:00:00Z' limitKw: type: number format: float exclusiveMinimum: 0 description: Limite de potência em kW. Deve ser maior que 0. Obrigatório. example: 50 priority: type: integer minimum: 0 maximum: 10 default: 0 description: | Nível de prioridade no estilo da pilha OCPP, de 0 (mais baixa) a 10 (mais alta). O envio de um perfil em uma prioridade que já existe para este alvo o substitui. example: 5 OrgScheduleResponse: type: object properties: tenantUuid: type: string priority: type: integer example: 5 limitKw: type: number example: 500 startTime: type: string format: date-time endTime: type: string format: date-time status: $ref: '#/components/schemas/ProfileStatus' note: type: string example: >- Organization-wide cap enforcement is not yet active; this profile is recorded for future use. ProfileStatus: type: string enum: - SCHEDULED - ACTIVE - EXPIRED Error: type: object properties: error: type: object properties: code: type: string example: LOCATION_NOT_FOUND message: type: string example: Location 123 was not found for the provided tenant requestId: type: string format: uuid responses: BadRequest: description: Corpo da requisição inválido ou alvo inativo content: application/json: schema: $ref: '#/components/schemas/Error' examples: invalidBody: summary: INVALID_REQUEST_BODY value: error: code: INVALID_REQUEST_BODY message: limitKw must be a positive number requestId: b1f6e6b0-1234-4abc-9def-000000000000 targetInactive: summary: TARGET_INACTIVE value: error: code: TARGET_INACTIVE message: Location 123 is not active requestId: b1f6e6b0-1234-4abc-9def-000000000000 Unauthorized: description: Chave de API ausente, inválida ou expirada content: application/json: schema: $ref: '#/components/schemas/Error' examples: unauthorized: value: error: code: UNAUTHORIZED message: Invalid or inactive API key requestId: b1f6e6b0-1234-4abc-9def-000000000000 FeatureNotEnabled: description: O tenant não possui a Energy Management API habilitada content: application/json: schema: $ref: '#/components/schemas/Error' examples: featureNotEnabled: value: error: code: FEATURE_NOT_ENABLED message: >- The Energy Management API is not enabled for your account. Contact RiDERgy to enable this feature. requestId: b1f6e6b0-1234-4abc-9def-000000000000 securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-api-key description: >- Chave de API por tenant. O tenant é derivado da chave — nunca da requisição. ````