<head>
<title>Parametros de Sistema</title>
<style type="text/css">
body {
font-family: Trebuchet MS, sans-serif;
font-size: 15px;
color: #444;
margin-right: 24px;
}
h1 {
font-size: 25px;
}
h2 {
font-size: 20px;
}
h3 {
font-size: 16px;
font-weight: bold;
}
hr {
height: 1px;
border: 0;
color: #ddd;
background-color: #ddd;
}
.app-desc {
clear: both;
margin-left: 20px;
}
.param-name {
width: 100%;
}
.license-info {
margin-left: 20px;
}
.license-url {
margin-left: 20px;
}
.model {
margin: 0 0 0px 20px;
}
.method {
margin-left: 20px;
}
.method-notes {
margin: 10px 0 20px 0;
font-size: 90%;
color: #555;
}
pre {
padding: 10px;
margin-bottom: 2px;
}
.http-method {
text-transform: uppercase;
}
pre.get {
background-color: #0f6ab4;
}
pre.post {
background-color: #10a54a;
}
pre.put {
background-color: #c5862b;
}
pre.delete {
background-color: #a41e22;
}
.huge {
color: #fff;
}
pre.example {
background-color: #f3f3f3;
padding: 10px;
border: 1px solid #ddd;
}
code {
white-space: pre;
}
.nickname {
font-weight: bold;
}
.method-path {
font-size: 1.5em;
background-color: #0f6ab4;
}
.up {
float:right;
}
.parameter {
width: 500px;
}
.param {
width: 500px;
padding: 10px 0 0 20px;
font-weight: bold;
}
.param-desc {
width: 700px;
padding: 0 0 0 20px;
color: #777;
}
.param-type {
font-style: italic;
}
.param-enum-header {
width: 700px;
padding: 0 0 0 60px;
color: #777;
font-weight: bold;
}
.param-enum {
width: 700px;
padding: 0 0 0 80px;
color: #777;
font-style: italic;
}
.field-label {
padding: 0;
margin: 0;
clear: both;
}
.field-items {
padding: 0 0 15px 0;
margin-bottom: 15px;
}
.return-type {
clear: both;
padding-bottom: 10px;
}
.param-header {
font-weight: bold;
}
.method-tags {
text-align: right;
}
.method-tag {
background: none repeat scroll 0% 0% #24A600;
border-radius: 3px;
padding: 2px 10px;
margin: 2px;
color: #FFF;
display: inline-block;
text-decoration: none;
}
</style>
</head>
<body>
<h1>Parametros de Sistema</h1>
<div class="app-desc">API para os parâmetros de sistemas do produtos TOTVS</div>
<div class="app-desc">More information: <a href="API.Totvs.com.br">API.Totvs.com.br</a></div>
<div class="app-desc">Contact Info: <a href="[email protected]">[email protected]</a></div>
<div class="app-desc">Version: 1.000</div>
<div class="license-info">All rights reserved</div>
<div class="license-url">http://apache.org/licenses/LICENSE-2.0.html</div>
<h2>Access</h2>
<h2><a name="__Methods">Methods</a></h2>
[ Jump to <a href="#__Models">Models</a> ]
<h3>Table of Contents </h3>
<div class="method-summary"></div>
<h4><a href="#SystemParameters">SystemParameters</a></h4>
<ul>
<li><a href="#deleteParameterId"><code><span class="http-method">delete</span> /systemParameters/{systemParameterId}</code></a></li>
<li><a href="#getSystemParameters"><code><span class="http-method">get</span> /systemParameters</code></a></li>
<li><a href="#postParameter"><code><span class="http-method">post</span> /systemParameters</code></a></li>
<li><a href="#postParameterId"><code><span class="http-method">put</span> /systemParameters/{systemParameterId}</code></a></li>
</ul>
<h1><a name="SystemParameters">SystemParameters</a></h1>
<div class="method"><a name="deleteParameterId"></a>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="delete"><code class="huge"><span class="http-method">delete</span> /systemParameters/{systemParameterId}</code></pre></div>
<div class="method-summary">Exclusão de parâmetro da base (<span class="nickname">deleteParameterId</span>)</div>
<div class="method-notes">Exclusão de parâmetro da base</div>
<h3 class="field-label">Path parameters</h3>
<div class="field-items">
<div class="param">systemParameterId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> — Identificador Único representando o parâmetro </div> </div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
<a href="#ParameterInfo">ParameterInfo</a>
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{
"branchID" : "branchID",
"companyID" : "companyID",
"code" : "code",
"scope" : "global",
"description" : [ {
"language" : "language",
"descriptionText" : "descriptionText"
}, {
"language" : "language",
"descriptionText" : "descriptionText"
} ],
"systemParameterId" : "systemParameterId",
"type" : "type",
"value" : [ {
"language" : "language",
"parameterValue" : "parameterValue"
}, {
"language" : "language",
"parameterValue" : "parameterValue"
} ],
"group" : {
"displayName" : { },
"name" : "name",
"customData" : { }
}
}</code></pre>
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
Operação realizada com sucesso
<a href="#ParameterInfo">ParameterInfo</a>
<h4 class="field-label">405</h4>
Não disponivel
<a href="#ErrorModel">ErrorModel</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="getSystemParameters"></a>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="get"><code class="huge"><span class="http-method">get</span> /systemParameters</code></pre></div>
<div class="method-summary">Retorna todos os parâmetros do sistema (<span class="nickname">getSystemParameters</span>)</div>
<div class="method-notes">Retorna todos os parâmetros do sistema</div>
<h3 class="field-label">Request headers</h3>
<div class="field-items">
</div> <!-- field-items -->
<h3 class="field-label">Query parameters</h3>
<div class="field-items">
<div class="param">order (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> — Ordenação da Coleção </div> <div class="param">page (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> — Paginação da Coleção default: 1 format: int32</div> <div class="param">pageSize (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> — Quantidade de Itens por Página default: 10 format: int32</div> <div class="param">fields (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> — Filtering records fields </div> <div class="param">codes (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> — Códigos de parâmetros retornados pelo get separado por vírgula (,) </div> <div class="param">description (optional)</div>
<div class="param-desc"><span class="param-type">Query Parameter</span> — Busca de descrição do paramêtro </div> </div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
<a href="#PagedParameters">PagedParameters</a>
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>""</code></pre>
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
Operação realizada com sucesso
<a href="#PagedParameters">PagedParameters</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="postParameter"></a>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="post"><code class="huge"><span class="http-method">post</span> /systemParameters</code></pre></div>
<div class="method-summary">Inclui o parâmetro passado na requisição (<span class="nickname">postParameter</span>)</div>
<div class="method-notes">Inclui o parâmetro passado na requisição</div>
<h3 class="field-label">Consumes</h3>
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">body <a href="#ParameterInfo">ParameterInfo</a> (optional)</div>
<div class="param-desc"><span class="param-type">Body Parameter</span> — Parâmetro para ser incluido </div>
</div> <!-- field-items -->
<h3 class="field-label">Request headers</h3>
<div class="field-items">
</div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
<a href="#PagedParameters">PagedParameters</a>
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>""</code></pre>
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
Operação realizada com sucesso
<a href="#PagedParameters">PagedParameters</a>
<h4 class="field-label">400</h4>
erro no momento da Inclusão
<a href="#ErrorModel">ErrorModel</a>
</div> <!-- method -->
<hr/>
<div class="method"><a name="postParameterId"></a>
<div class="method-path">
<a class="up" href="#__Methods">Up</a>
<pre class="put"><code class="huge"><span class="http-method">put</span> /systemParameters/{systemParameterId}</code></pre></div>
<div class="method-summary">Altera o parâmetro passado na requisição (<span class="nickname">postParameterId</span>)</div>
<div class="method-notes">Altera o parâmetro passado na requisição</div>
<h3 class="field-label">Path parameters</h3>
<div class="field-items">
<div class="param">systemParameterId (required)</div>
<div class="param-desc"><span class="param-type">Path Parameter</span> — Identificador Único representando o parâmetro </div> </div> <!-- field-items -->
<h3 class="field-label">Consumes</h3>
This API call consumes the following media types via the <span class="header">Content-Type</span> request header:
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Request body</h3>
<div class="field-items">
<div class="param">body <a href="#ParameterInfo">ParameterInfo</a> (optional)</div>
<div class="param-desc"><span class="param-type">Body Parameter</span> — Parâmetro para ser incluído </div>
</div> <!-- field-items -->
<h3 class="field-label">Request headers</h3>
<div class="field-items">
</div> <!-- field-items -->
<h3 class="field-label">Return type</h3>
<div class="return-type">
<a href="#ParameterInfo">ParameterInfo</a>
</div>
<!--Todo: process Response Object and its headers, schema, examples -->
<h3 class="field-label">Example data</h3>
<div class="example-data-content-type">Content-Type: application/json</div>
<pre class="example"><code>{
"branchID" : "branchID",
"companyID" : "companyID",
"code" : "code",
"scope" : "global",
"description" : [ {
"language" : "language",
"descriptionText" : "descriptionText"
}, {
"language" : "language",
"descriptionText" : "descriptionText"
} ],
"systemParameterId" : "systemParameterId",
"type" : "type",
"value" : [ {
"language" : "language",
"parameterValue" : "parameterValue"
}, {
"language" : "language",
"parameterValue" : "parameterValue"
} ],
"group" : {
"displayName" : { },
"name" : "name",
"customData" : { }
}
}</code></pre>
<h3 class="field-label">Produces</h3>
This API call produces the following media types according to the <span class="header">Accept</span> request header;
the media type will be conveyed by the <span class="header">Content-Type</span> response header.
<ul>
<li><code>application/json</code></li>
</ul>
<h3 class="field-label">Responses</h3>
<h4 class="field-label">200</h4>
Operação realizada com sucesso
<a href="#ParameterInfo">ParameterInfo</a>
<h4 class="field-label">400</h4>
erro no momento da Inclusão
<a href="#ErrorModel">ErrorModel</a>
<h4 class="field-label">404</h4>
Parâmetro não localizado na base
<a href="#ErrorModel">ErrorModel</a>
</div> <!-- method -->
<hr/>
<h2><a name="__Models">Models</a></h2>
[ Jump to <a href="#__Methods">Methods</a> ]
<h3>Table of Contents</h3>
<ol>
<li><a href="#ErrorDetail"><code>ErrorDetail</code></a></li>
<li><a href="#ErrorModel"><code>ErrorModel</code></a></li>
<li><a href="#ErrorModelBase"><code>ErrorModelBase</code></a></li>
<li><a href="#PagedParameters"><code>PagedParameters</code></a></li>
<li><a href="#Paging"><code>Paging</code></a></li>
<li><a href="#ParameterDescription"><code>ParameterDescription</code></a></li>
<li><a href="#ParameterInfo"><code>ParameterInfo</code></a></li>
<li><a href="#ParameterInfo_group"><code>ParameterInfo_group</code></a></li>
<li><a href="#ParameterValues"><code>ParameterValues</code></a></li>
<li><a href="#SystemParameters"><code>SystemParameters</code></a></li>
</ol>
<div class="model">
<h3><a name="ErrorDetail"><code>ErrorDetail</code></a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">details (optional)</div><div class="param-desc"><span class="param-type"><a href="#ErrorModelBase">array[ErrorModelBase]</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="ErrorModel"><code>ErrorModel</code></a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">details (optional)</div><div class="param-desc"><span class="param-type"><a href="#ErrorModelBase">array[ErrorModelBase]</a></span> </div>
<div class="param">code </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Código identificador do erro. </div>
<div class="param">message </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Literal no idioma da requisição descrevendo o erro para o usuário. </div>
<div class="param">detailedMessage </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Mensagem técnica e mais detalhada do erro. </div>
<div class="param">helpUrl (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> URI para documentação do erro. format: uri</div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="ErrorModelBase"><code>ErrorModelBase</code></a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">code </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Código identificador do erro. </div>
<div class="param">message </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Literal no idioma da requisição descrevendo o erro para o usuário. </div>
<div class="param">detailedMessage </div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Mensagem técnica e mais detalhada do erro. </div>
<div class="param">helpUrl (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> URI para documentação do erro. format: uri</div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="PagedParameters"><code>PagedParameters</code></a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">items (optional)</div><div class="param-desc"><span class="param-type"><a href="#ParameterInfo">array[ParameterInfo]</a></span> </div>
<div class="param">hasNext (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
<div class="param-desc"><span class="param-type">example: false</span></div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="Paging"><code>Paging</code></a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">hasNext (optional)</div><div class="param-desc"><span class="param-type"><a href="#boolean">Boolean</a></span> </div>
<div class="param-desc"><span class="param-type">example: false</span></div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="ParameterDescription"><code>ParameterDescription</code></a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Descrição do paramêtro</div>
<div class="field-items">
<div class="param">language (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Idioma da descrição do paramêtro - deverá obedecer a ISO6391 (exemplo em https://www.andiamo.co.uk/resources/iso-language-codes) </div>
<div class="param">descriptionText (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Texto da descrição do paramêtro </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="ParameterInfo"><code>ParameterInfo</code></a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">systemParameterId (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Identificador parâmetro de sistema </div>
<div class="param">companyID (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Código da empresa </div>
<div class="param">branchID (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Código da Filial </div>
<div class="param">code (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Código do parâmetro </div>
<div class="param">type (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Tipo do paramêtro </div>
<div class="param">description (optional)</div><div class="param-desc"><span class="param-type"><a href="#ParameterDescription">array[ParameterDescription]</a></span> </div>
<div class="param">value (optional)</div><div class="param-desc"><span class="param-type"><a href="#ParameterValues">array[ParameterValues]</a></span> </div>
<div class="param">scope (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param-enum-header">Enum:</div>
<div class="param-enum">global</div><div class="param-enum">company</div><div class="param-enum">companyUser</div><div class="param-enum">user</div>
<div class="param">group (optional)</div><div class="param-desc"><span class="param-type"><a href="#ParameterInfo_group">ParameterInfo_group</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="ParameterInfo_group"><code>ParameterInfo_group</code></a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">name (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> </div>
<div class="param">displayName (optional)</div><div class="param-desc"><span class="param-type"><a href="#object">Object</a></span> </div>
<div class="param">customData (optional)</div><div class="param-desc"><span class="param-type"><a href="#object">Object</a></span> </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="ParameterValues"><code>ParameterValues</code></a> <a class="up" href="#__Models">Up</a></h3>
<div class='model-description'>Valor do paramêtro</div>
<div class="field-items">
<div class="param">language (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Idioma do valor do paramêtro </div>
<div class="param">parameterValue (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span> Valor do paramêtro </div>
</div> <!-- field-items -->
</div>
<div class="model">
<h3><a name="SystemParameters"><code>SystemParameters</code></a> <a class="up" href="#__Models">Up</a></h3>
<div class="field-items">
<div class="param">items (optional)</div><div class="param-desc"><span class="param-type"><a href="#ParameterInfo">array[ParameterInfo]</a></span> </div>
</div> <!-- field-items -->
</div>
</body> |