| Tabla de contenidos |
|---|
Índice Principal
| Presentación de hijos | ||
|---|---|---|
|
| UI Expand | |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
|
| Info |
|---|
Versiones descontinuadas
|
Modelo de entidad-relación a un nivel
lucidchartdraw.io Diagram
|
|
|
|
|
|
Consulta
Para obtener el listado de componentes de CMS la API dispone del método:
| HTML |
|---|
<div style="margin: 0 0 15px;margin-top: 0px;margin-right: 0px;margin-bottom: 15px;margin-left: 0px;border: 1px solid #000;border-radius: 4px;-webkit-box-shadow: 0 0 3px rgba(0,0,0,.19);box-shadow: 0 0 3px rgba(0,0,0,.19);border-color: #61affe;background: rgba(97,175,254,.1);"><div style="border-color: #61affe;display: flex;-webkit-box-align: center;align-items: center;padding: 5px;"><span style="background: #61affe;font-size: 14px;font-weight: 700;min-width: 80px;padding: 6px 15px;text-align: center;border-radius: 3px;text-shadow: 0 1px 0 rgba(0,0,0,.1);font-family: sans-serif;color: #fff;">GET</span><span style="font-size: 16px;display: -webkit-box;display: -ms-flexbox;display: flex;-webkit-box-flex: 0;-ms-flex: 0 3 auto;flex: 0 3 auto;-webkit-box-align: center;-ms-flex-align: center;align-items: center;word-break: break-all;padding: 0 10px;font-family: monospace;font-weight: 600;color: #3b4151;">/cgescms/componentes</span><div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Obtener componentes</div></div></div> |
Podemos consultar el detalle de un componente mediante el método disponible:
| HTML |
|---|
<div style="margin: 0 0 15px;margin-top: 0px;margin-right: 0px;margin-bottom: 15px;margin-left: 0px;border: 1px solid #000;border-radius: 4px;-webkit-box-shadow: 0 0 3px rgba(0,0,0,.19);box-shadow: 0 0 3px rgba(0,0,0,.19);border-color: #61affe;background: rgba(97,175,254,.1);"><div style="border-color: #61affe;display: flex;-webkit-box-align: center;align-items: center;padding: 5px;"><span style="background: #61affe;font-size: 14px;font-weight: 700;min-width: 80px;padding: 6px 15px;text-align: center;border-radius: 3px;text-shadow: 0 1px 0 rgba(0,0,0,.1);font-family: sans-serif;color: #fff;">GET</span><span style="font-size: 16px;display: -webkit-box;display: -ms-flexbox;display: flex;-webkit-box-flex: 0;-ms-flex: 0 3 auto;flex: 0 3 auto;-webkit-box-align: center;-ms-flex-align: center;align-items: center;word-break: break-all;padding: 0 10px;font-family: monospace;font-weight: 600;color: #3b4151;">/cgescms/componentes/{uuidComponente}</span><div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Obtener componente</div></div></div> |
Además de los atributos propios de la entidad, en la respuesta visualizaremos la sección de enlaces que nos permite el acceso directo a información extendida sobre el componente.
Creación y edición
Es posible crear componentes mediante el método disponible para tal fin. Se debe usar la versión v2.0:
| HTML |
|---|
<div style="margin: 0 0 15px;margin-top: 0px;margin-right: 0px;margin-bottom: 15px;margin-left: 0px;border: 1px solid #000;border-radius: 4px;-webkit-box-shadow: 0 0 3px rgba(0,0,0,.19);box-shadow: 0 0 3px rgba(0,0,0,.19);border-color: #49cc90;background: rgba(73,204,144,.1);"><div style="border-color: #49cc90;display: flex;-webkit-box-align: center;align-items: center;padding: 5px;"><span style="background: #49cc90;font-size: 14px;font-weight: 700;min-width: 80px;padding: 6px 15px;text-align: center;border-radius: 3px;text-shadow: 0 1px 0 rgba(0,0,0,.1);font-family: sans-serif;color: #fff;">POST</span><span style="font-size: 16px;display: -webkit-box;display: -ms-flexbox;display: flex;-webkit-box-flex: 0;-ms-flex: 0 3 auto;flex: 0 3 auto;-webkit-box-align: center;-ms-flex-align: center;align-items: center;word-break: break-all;padding: 0 10px;font-family: monospace;font-weight: 600;color: #3b4151;">/cgescms/componentes</span><div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Crear componente</div></div></div> |
Requisitos funcionales
- El nombre es obligatorio, no puede superar los 100 caracteres ni puede existir otro componente con el mismo nombre.
- El código de componente no es editable y para crearlo, es obligatorio y no puede superar los 100 caracteres.
- El código ALM es obligatorio y no debe superar los 255 caracteres. No debe existir para otro componente el mismo valor.
- El campo ¿Desarrollo a medida? es opcional.
- Es obligatorio indicar si el componente cuenta con revisión de la OCA para AT1. Será forzado a NO para AT2.
- La descripción funcional es opcional y no puede superar los 2000 caracteres.
- El tipo de componente es obligatorio y debe ser válido.
- El repositorio de código es opcional y no puede superar los 255 caracteres.
- La aplicación deberá ser válida y estar en estado VIGENTE. No debe tener la categoría de Servicios Tecnológicos, ya que no es compatible con componentes.
- La tecnología de desarrollo es obligatoria, el componente se creará en estado temporal (no válido) hasta que se le asocie una primera tecnología invocando a su método independiente.
- También existe un método independiente para asociar una aplicación origen. Esta no es obligatoria y sólo se permite una única asociación por componente. Hay otro método para eliminar la asociación.
| Info |
|---|
Versiones descontinuadas: v1.0 |
También podremos modificar diferentes atributos de una aplicación mediante el método siguiente en su versión v2.0:
| HTML |
|---|
<div style="margin: 0 0 15px;margin-top: 0px;margin-right: 0px;margin-bottom: 15px;margin-left: 0px;border: 1px solid #000;border-radius: 4px;-webkit-box-shadow: 0 0 3px rgba(0,0,0,.19);box-shadow: 0 0 3px rgba(0,0,0,.19);border-color: #fca130;background: rgba(252,161,48,.1);"><div style="border-color: #fca130;display: flex;-webkit-box-align: center;align-items: center;padding: 5px;"><span style="background: #fca130;font-size: 14px;font-weight: 700;min-width: 80px;padding: 6px 15px;text-align: center;border-radius: 3px;text-shadow: 0 1px 0 rgba(0,0,0,.1);font-family: sans-serif;color: #fff;">PUT</span><span style="font-size: 16px;display: -webkit-box;display: -ms-flexbox;display: flex;-webkit-box-flex: 0;-ms-flex: 0 3 auto;flex: 0 3 auto;-webkit-box-align: center;-ms-flex-align: center;align-items: center;word-break: break-all;padding: 0 10px;font-family: monospace;font-weight: 600;color: #3b4151;">/cgescms/componentes/{uuidComponente}</span><div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Modificar componente</div></div></div> |
Requisitos funcionales
- El componente a modificar debe ser válido.
- Mismos requisitos a nivel de campos que en la creación.
- No se permite dar de baja un componente si existe una relación grupo lógico-entorno-plataforma con alguna versión activa.
| Advertencia | ||
|---|---|---|
| ||
Para realizar correctamente la modificación se debe enviar el recurso completo cada vez que se consuma este recurso. En caso de no enviar alguno de los valores, el recurso borrará la información para los atributos no informados. |
| Info |
|---|
Versiones descontinuadas: v1.0 |
Tecnologías de desarrollo
Una vez disponga de un identificador de componente (uuidComponente), podrá consultar, asociar o quitar tecnologías de desarrollo haciendo uso de estos métodos:
| HTML |
|---|
<div style="margin: 0 0 15px;margin-top: 0px;margin-right: 0px;margin-bottom: 15px;margin-left: 0px;border: 1px solid #000;border-radius: 4px;-webkit-box-shadow: 0 0 3px rgba(0,0,0,.19);box-shadow: 0 0 3px rgba(0,0,0,.19);border-color: #61affe;background: rgba(97,175,254,.1);"><div style="border-color: #61affe;display: flex;-webkit-box-align: center;align-items: center;padding: 5px;"><span style="background: #61affe;font-size: 14px;font-weight: 700;min-width: 80px;padding: 6px 15px;text-align: center;border-radius: 3px;text-shadow: 0 1px 0 rgba(0,0,0,.1);font-family: sans-serif;color: #fff;">GET</span><span style="font-size: 16px;display: -webkit-box;display: -ms-flexbox;display: flex;-webkit-box-flex: 0;-ms-flex: 0 3 auto;flex: 0 3 auto;-webkit-box-align: center;-ms-flex-align: center;align-items: center;word-break: break-all;padding: 0 10px;font-family: monospace;font-weight: 600;color: #3b4151;">/cgescms/componentes/{uuidComponente}/tecnologiasdesarrollo</span><div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Obtener tecnologías de desarrollo</div></div></div><div style="margin: 0 0 15px;margin-top: 0px;margin-right: 0px;margin-bottom: 15px;margin-left: 0px;border: 1px solid #000;border-radius: 4px;-webkit-box-shadow: 0 0 3px rgba(0,0,0,.19);box-shadow: 0 0 3px rgba(0,0,0,.19);border-color: #49cc90;background: rgba(73,204,144,.1);"><div style="border-color: #49cc90;display: flex;-webkit-box-align: center;align-items: center;padding: 5px;"><span style="background: #49cc90;font-size: 14px;font-weight: 700;min-width: 80px;padding: 6px 15px;text-align: center;border-radius: 3px;text-shadow: 0 1px 0 rgba(0,0,0,.1);font-family: sans-serif;color: #fff;">POST</span><span style="font-size: 16px;display: -webkit-box;display: -ms-flexbox;display: flex;-webkit-box-flex: 0;-ms-flex: 0 3 auto;flex: 0 3 auto;-webkit-box-align: center;-ms-flex-align: center;align-items: center;word-break: break-all;padding: 0 10px;font-family: monospace;font-weight: 600;color: #3b4151;">/cgescms/componentes/{uuidComponente}/tecnologiasdesarrollo</span><div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Asociar tecnologías de desarrollo</div></div></div><div style="margin: 0 0 15px;margin-top: 0px;margin-right: 0px;margin-bottom: 15px;margin-left: 0px;border: 1px solid #000;border-radius: 4px;-webkit-box-shadow: 0 0 3px rgba(0,0,0,.19);box-shadow: 0 0 3px rgba(0,0,0,.19);border-color: #f93e3e;background: rgba(249,62,62,.1);"><div style="border-color: #f93e3e;display: flex;-webkit-box-align: center;align-items: center;padding: 5px;"><span style="background: #f93e3e;font-size: 14px;font-weight: 700;min-width: 80px;padding: 6px 15px;text-align: center;border-radius: 3px;text-shadow: 0 1px 0 rgba(0,0,0,.1);font-family: sans-serif;color: #fff;">DELETE</span><span style="font-size: 16px;display: -webkit-box;display: -ms-flexbox;display: flex;-webkit-box-flex: 0;-ms-flex: 0 3 auto;flex: 0 3 auto;-webkit-box-align: center;-ms-flex-align: center;align-items: center;word-break: break-all;padding: 0 10px;font-family: monospace;font-weight: 600;color: #3b4151;">/cgescms/componentes/{uuidComponente}/tecnologiasdesarrollo/{idTecnologiaDesarrollo}</span><div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Desvincular tecnologías de desarrollo</div></div></div> |
Requisitos funcionales
- La tecnología de desarrollo es obligatoria, el componente se creará en estado temporal (no válido) hasta que se le asocie una primera tecnología.
- No se podrá eliminar una tecnología a un componente si es la última que le queda asociada.
Aplicación Origen
Una vez disponga de un identificador de componente (uuidComponente), podrá actualizar su valor o borrarlo utilizando los siguientes métodos:
| HTML |
|---|
<div style="margin: 0 0 15px;margin-top: 0px;margin-right: 0px;margin-bottom: 15px;margin-left: 0px;border: 1px solid #000;border-radius: 4px;-webkit-box-shadow: 0 0 3px rgba(0,0,0,.19);box-shadow: 0 0 3px rgba(0,0,0,.19);border-color: #49cc90;background: rgba(73,204,144,.1);"><div style="border-color: #49cc90;display: flex;-webkit-box-align: center;align-items: center;padding: 5px;"><span style="background: #49cc90;font-size: 14px;font-weight: 700;min-width: 80px;padding: 6px 15px;text-align: center;border-radius: 3px;text-shadow: 0 1px 0 rgba(0,0,0,.1);font-family: sans-serif;color: #fff;">POST</span><span style="font-size: 16px;display: -webkit-box;display: -ms-flexbox;display: flex;-webkit-box-flex: 0;-ms-flex: 0 3 auto;flex: 0 3 auto;-webkit-box-align: center;-ms-flex-align: center;align-items: center;word-break: break-all;padding: 0 10px;font-family: monospace;font-weight: 600;color: #3b4151;">/cgescms/componentes/{uuidComponente}/aplicacionesorigen</span><div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Asociar una aplicación de origen a un componente</div></div></div><div style="margin: 0 0 15px;margin-top: 0px;margin-right: 0px;margin-bottom: 15px;margin-left: 0px;border: 1px solid #000;border-radius: 4px;-webkit-box-shadow: 0 0 3px rgba(0,0,0,.19);box-shadow: 0 0 3px rgba(0,0,0,.19);border-color: #f93e3e;background: rgba(249,62,62,.1);"><div style="border-color: #f93e3e;display: flex;-webkit-box-align: center;align-items: center;padding: 5px;"><span style="background: #f93e3e;font-size: 14px;font-weight: 700;min-width: 80px;padding: 6px 15px;text-align: center;border-radius: 3px;text-shadow: 0 1px 0 rgba(0,0,0,.1);font-family: sans-serif;color: #fff;">DELETE</span><span style="font-size: 16px;display: -webkit-box;display: -ms-flexbox;display: flex;-webkit-box-flex: 0;-ms-flex: 0 3 auto;flex: 0 3 auto;-webkit-box-align: center;-ms-flex-align: center;align-items: center;word-break: break-all;padding: 0 10px;font-family: monospace;font-weight: 600;color: #3b4151;">/cgescms/componentes/{uuidComponente}/aplicacionesorigen/{idTecnologiaDesarrollo}</span><div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Desvincular una aplicación de origen de un componente</div></div></div> |
Entidades asociadas
Aplicación
La aplicación asociada se suministra como un parámetro de la respuesta.
Versiones
Consulte el apartado correspondiente a las versiones en la documentación.
Relaciones grupo lógico-entorno-plataforma
Para obtener las plataformas en las que está desplegado el componente, se puede usar el siguiente método filtrando por el identificador que estamos consultando (uuidComponente) y el atributo estado con la versión v1.0 .
Se obtiene así la relación de todas las versiones y las plataformas en las que están instaladas para un mismo componente.
| HTML |
|---|
<div style="margin: 0 0 15px;margin-top: 0px;margin-right: 0px;margin-bottom: 15px;margin-left: 0px;border: 1px solid #000;border-radius: 4px;-webkit-box-shadow: 0 0 3px rgba(0,0,0,.19);box-shadow: 0 0 3px rgba(0,0,0,.19);border-color: #61affe;background: rgba(97,175,254,.1);"><div style="border-color: #61affe;display: flex;-webkit-box-align: center;align-items: center;padding: 5px;"><span style="background: #61affe;font-size: 14px;font-weight: 700;min-width: 80px;padding: 6px 15px;text-align: center;border-radius: 3px;text-shadow: 0 1px 0 rgba(0,0,0,.1);font-family: sans-serif;color: #fff;">GET</span><span style="font-size: 16px;display: -webkit-box;display: -ms-flexbox;display: flex;-webkit-box-flex: 0;-ms-flex: 0 3 auto;flex: 0 3 auto;-webkit-box-align: center;-ms-flex-align: center;align-items: center;word-break: break-all;padding: 0 10px;font-family: monospace;font-weight: 600;color: #3b4151;">/cgescms/versiones/relgrplogentplats</span><div style="font-size: 13px;-webkit-box-flex: 1;-ms-flex: 1;flex: 1;font-family: sans-serif;color: #3b4151;">Obtener versiones y grupos lógicos</div></div></div> |
| Info |
|---|
Ejemplo /cgescms/versiones/relgrplogentplats?uuidComponente=DEF95790523001FA875F000C29B08512&estado=0 |
Se suministra un enlace en la consulta del listado y detalle del componente.