Strategy by indicators

documento /v3/api docs/strategy · pacote generated/strategy · 64 operações método do sdk descrição http caminho escopo exigido corpo actionplancontrolleraddaction acrescenta uma ação ao plano, com responsável e prazo post /api/strategy/action plans/{planid}/actions manage action plan actionrequest actionplancontrolleraddcause acrescenta uma causa à árvore de causas do plano post /api/strategy/action plans/{planid}/causes manage action plan causerequest actionplancontrollercreateplan abre um plano de ação para tratar um desvio post /api/strategy/indicators/{indicatorid}/action plans manage action plan planrequest actionplancontrollergetplan detalha um plano de ação com as suas ações e causas get /api/strategy/action plans/{id} manage strategy — actionplancontrollerlistactions lista as ações de um plano get /api/strategy/action plans/{planid}/actions manage strategy — actionplancontrollerlistcauses lista as causas levantadas na análise do desvio get /api/strategy/action plans/{planid}/causes manage strategy — actionplancontrollerlistplans lista os planos de ação, opcionalmente os de um indicador get /api/strategy/indicators/{indicatorid}/action plans manage strategy — actionplancontrollermovecause reposiciona uma causa na árvore post /api/strategy/causes/{id}/move manage action plan moverequest actionplancontrollerremoveaction remove uma ação do plano delete /api/strategy/actions/{id} manage action plan — actionplancontrollerremovecause remove uma causa da árvore delete /api/strategy/causes/{id} manage action plan — actionplancontrollertransitionplan move o plano de ação para a próxima situação do fluxo post /api/strategy/action plans/{id}/transition manage action plan transitionrequest actionplancontrollerupdateaction altera responsável, prazo ou descrição de uma ação put /api/strategy/actions/{id} manage action plan actionrequest actionplancontrollerupdateactionstatus avança a situação de uma ação do plano post /api/strategy/actions/{id}/status manage action plan actionstatusrequest actionplancontrollerupdatepdca registra a etapa do ciclo pdca em que o plano está post /api/strategy/actions/{id}/pdca manage action plan pdcarequest actionplancontrollerupdateplan altera os dados 5w2h do plano de ação put /api/strategy/action plans/{id} manage action plan planrequest indicatorscontrolleractivatecycle ativa o ciclo — a partir daí ele recebe objetivos e metas post /api/strategy/cycles/{id}/activate manage strategy — indicatorscontrolleraddperspective acrescenta uma perspectiva ao ciclo post /api/strategy/cycles/{id}/perspectives manage strategy namerequest indicatorscontrollerapplyindicatorapproval aplica a decisão de aprovação da ficha post /api/strategy/indicators/{indicatorid}/apply approval manage indicator — indicatorscontrollerapplytargetapproval aplica a decisão de aprovação da meta post /api/strategy/targets/{targetid}/apply approval manage indicator — indicatorscontrollerapure apura o indicador no período e devolve o valor calculado post /api/strategy/indicators/{indicatorid}/apure record measurement apurerequest indicatorscontrollercascade desdobra o objetivo para as áreas indicadas de uma vez get /api/strategy/cycles/{cycleid}/cascade manage strategy — indicatorscontrollerchangelens troca a lente do ciclo (bsc, okr ou livre) post /api/strategy/cycles/{id}/lens manage strategy lensrequest indicatorscontrollerclosecycle encerra o ciclo; os números apurados permanecem consultáveis post /api/strategy/cycles/{id}/close manage strategy — indicatorscontrollercreatecycle cria um ciclo de planejamento estratégico post /api/strategy/cycles manage strategy createcyclerequest indicatorscontrollercreateindicator cria a ficha de um indicador post /api/strategy/indicators manage indicator indicatorrequest indicatorscontrollercreatelink desdobra um objetivo em outro, com peso de contribuição post /api/strategy/links manage strategy linkrequest indicatorscontrollercreateobjective cria um objetivo dentro do ciclo post /api/strategy/cycles/{cycleid}/objectives manage strategy objectiverequest indicatorscontrollercreatetarget define a meta do indicador para um período post /api/strategy/indicators/{indicatorid}/targets manage indicator targetrequest indicatorscontrollerfreeze congela a medição do período — passa a valer como número oficial post /api/strategy/indicators/{indicatorid}/measurements/freeze record measurement measurementrequest indicatorscontrollergetcycle detalha um ciclo de planejamento estratégico get /api/strategy/cycles/{id} manage strategy — indicatorscontrollergetindicator detalha a ficha de um indicador get /api/strategy/indicators/{indicatorid} manage indicator — indicatorscontrollergetobjective detalha um objetivo get /api/strategy/objectives/{objectiveid} manage strategy — indicatorscontrollerlistcycles lista os ciclos de planejamento estratégico get /api/strategy/cycles manage strategy — indicatorscontrollerlistindicators lista as fichas de indicador; quem só lê o painel recebe apenas as aprovadas get /api/strategy/indicators manage indicator — indicatorscontrollerlistobjectiveindicators lista os indicadores de um objetivo com a meta vigente de cada um get /api/strategy/objectives/{objectiveid}/indicators manage strategy — indicatorscontrollerlistobjectives lista os objetivos de um ciclo get /api/strategy/cycles/{cycleid}/objectives manage strategy — indicatorscontrollerlistperspectives lista as perspectivas do ciclo get /api/strategy/cycles/{id}/perspectives manage strategy — indicatorscontrollerlisttargets lista as metas de um indicador get /api/strategy/indicators/{indicatorid}/targets manage strategy — indicatorscontrollermeasurementhistory devolve a trilha de alterações de uma medição get /api/strategy/indicators/{indicatorid}/measurements record measurement — indicatorscontrollermetriccatalog lista as métricas nativas que um indicador pode consumir get /api/strategy/metrics/catalog manage indicator — indicatorscontrollerpreviewformula simula a fórmula do indicador sem gravar nada post /api/strategy/metrics/formula/preview manage indicator formulapreviewrequest indicatorscontrollerrecalculate recalcula o indicador a partir do dado transacional post /api/strategy/indicators/{indicatorid}/recalculate record measurement — indicatorscontrollerrecordinprogress registra uma medição parcial, ainda não congelada post /api/strategy/indicators/{indicatorid}/measurements/in progress record measurement measurementrequest indicatorscontrollerrectify retifica uma medição congelada; a anterior permanece na trilha post /api/strategy/measurements/{measurementid}/rectify record measurement rectifyrequest indicatorscontrollerremoveindicator remove uma ficha de indicador sem metas delete /api/strategy/indicators/{indicatorid} manage indicator — indicatorscontrollerremovelink desfaz o desdobramento entre dois objetivos delete /api/strategy/links/{linkid} manage strategy — indicatorscontrollerremoveobjective remove um objetivo sem indicadores vinculados delete /api/strategy/objectives/{objectiveid} manage strategy — indicatorscontrollerremoveperspective remove uma perspectiva que não tenha objetivos delete /api/strategy/perspectives/{perspectiveid} manage strategy — indicatorscontrollerremovetarget remove uma meta ainda não apurada delete /api/strategy/targets/{targetid} manage indicator — indicatorscontrollerrenameperspective renomeia uma perspectiva do ciclo put /api/strategy/perspectives/{perspectiveid} manage strategy namerequest indicatorscontrollerreorderperspectives reordena as perspectivas do ciclo put /api/strategy/cycles/{id}/perspectives/order manage strategy reorderrequest indicatorscontrollerseries devolve a série histórica do indicador get /api/strategy/indicators/{indicatorid}/series record measurement — indicatorscontrollersubmitindicatorapproval envia a ficha do indicador para aprovação post /api/strategy/indicators/{indicatorid}/submit approval manage indicator — indicatorscontrollersubmittargetapproval envia a meta para aprovação post /api/strategy/targets/{targetid}/submit approval manage indicator — indicatorscontrollerupdateindicator altera a ficha de um indicador put /api/strategy/indicators/{indicatorid} manage indicator indicatorrequest indicatorscontrollerupdateobjective altera um objetivo put /api/strategy/objectives/{objectiveid} manage strategy objectiverequest indicatorscontrollerupdatetarget altera a meta de um período put /api/strategy/targets/{targetid} manage indicator targetrequest indicatorscontrollerwithdrawindicatorapproval devolve a ficha para rascunho post /api/strategy/indicators/{indicatorid}/withdraw approval manage indicator — indicatorscontrollerwithdrawtargetapproval devolve a meta para rascunho post /api/strategy/targets/{targetid}/withdraw approval manage indicator — performancegridcontrolleralignment devolve a árvore de alinhamento com o atingimento consolidado get /api/strategy/performance/{cycleid}/alignment view performance — performancegridcontrollerdashboard devolve o painel gerencial do ciclo get /api/strategy/performance/{cycleid}/dashboard view performance — performancegridcontrollerdrilldown abre o detalhe por trás de uma célula do painel get /api/strategy/performance/indicators/{indicatorid}/drill view performance — performancegridcontrollerexport exporta o painel de desempenho get /api/strategy/performance/{cycleid}/export view performance — performancegridcontrollergrid devolve o painel de desempenho do ciclo get /api/strategy/performance/{cycleid} view performance — corpos de requisição actionrequest campo tipo obrigatório observação howmethod string — — howmuchcost number — — whattitle string sim — whendue string (date) — — whenstart string (date) — — wherearea string — — whoemployeeid string (uuid) — — wholabel string — — whyreason string — — actionstatusrequest campo tipo obrigatório observação status string sim todo · doing · done · blocked · cancelled apurerequest campo tipo obrigatório observação periodend string (date) sim — periodstart string (date) sim — causerequest campo tipo obrigatório observação category string — — description string sim — parentid string (uuid) — — rootcause boolean — — createcyclerequest campo tipo obrigatório observação defaultlens string — gpd · bsc · okr name string sim — periodend string (date) sim — periodstart string (date) sim — formulapreviewrequest campo tipo obrigatório observação formula string sim — periodend string (date) sim — periodstart string (date) sim — indicatorrequest campo tipo obrigatório observação apurationperiod string — weekly · monthly · quarterly · semiannual · annual autoapuration boolean — — baseline number — — baselinedate string (date) — — confidential boolean — — maxapurationlagdays integer (int32) — — measurementtype string — snapshot · cumulative · average metricformula string — — metrickey string — — name string sim — objectiveid string (uuid) — — polarity string — higher is better · lower is better · target is best · stabilize progressdriver string — manual · rollup · calculated unit string — — lensrequest campo tipo obrigatório observação lens string sim gpd · bsc · okr linkrequest campo tipo obrigatório observação childobjectiveid string (uuid) sim — confidential boolean — — contributestorollup boolean — — correlationstrength string — weak · medium · strong linktype string — cascade · cause effect · support parentobjectiveid string (uuid) sim — weight number — — measurementrequest campo tipo obrigatório observação periodend string (date) sim — periodstart string (date) sim — value number sim — moverequest campo tipo obrigatório observação newparentid string (uuid) — — namerequest campo tipo obrigatório observação name string sim — objectiverequest campo tipo obrigatório observação confidential boolean — — departmentid string (uuid) — — description string — — measurementkind string — quantitative · qualitative objectivetype string — mission · vision · strategic · tactical · operational owneremployeeid string (uuid) — — perspectiveid string (uuid) — — title string sim — pdcarequest campo tipo obrigatório observação phase string — plan · do · check · act planrequest campo tipo obrigatório observação confidential boolean — — description string — — owneremployeeid string (uuid) — — periodend string (date) — — periodstart string (date) — — targetid string (uuid) — — title string sim — rectifyrequest campo tipo obrigatório observação note string sim — value number sim — reorderrequest campo tipo obrigatório observação orderedids string\[] sim — targetrequest campo tipo obrigatório observação acceptancecriteria string — — commitmenttype string — committed · stretch · aspirational periodend string (date) sim — periodstart string (date) sim — targetvalue number sim — tolerancelower number — — toleranceupper number — — weight number — — transitionrequest campo tipo obrigatório observação status string sim draft · pending approval · active · done · cancelled