createLevel
No se admite en API v20 +. Utilice updateLevels.
Categoría
| Modificación de metadatos |
Descripción
| Cree un nivel. Si se realiza correctamente, la API devuelve los detalles del nivel que se acaba de crear. |
Permisos obligatorios para invocar
| Estructura de la organización |
Parámetros obligatorios bajo petición
| Credenciales |
La solicitud de este método contiene una etiqueta de credenciales para identificar y autorizar al usuario que llama. El usuario debe tener permiso de estructura de organización para crear el nivel.
Este método devuelve un error si hay cambios no publicados.
Formato de solicitud
<?xml version='1.0' encoding='UTF-8'?> <call method="createLevel" callerName="fred"> <credentials login="sampleuser@company.com" password="my_pwd" /> <level name="New Level Name" shortName="NewLvlName" parentId="2" > <attributes> <attribute attributeId="20" valueId="199" /> </attributes> </level> </call>
elemento de credenciales
| |||
Nombre de etiqueta
| credenciales | ||
Descripción
| Todas las llamadas a la API deben contener un único elemento de credenciales para identificar al usuario que invoca la API. A continuación, la llamada a la API se realiza como este usuario (cualquier pista de auditoría o historial de acciones en el sistema mostrará que este usuario ha realizado la acción) y, por lo tanto, el usuario debe tener los permisos necesarios para realizar la acción a fin de que la llamada a la API se lleve a cabo. correcta | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿Obligatorio?
| Valor
| Ejemplo
|
inicio de sesión | Sí | El nombre de conexión del usuario que invoca el método API. Este usuario debe tener los permisos necesarios para invocar el método. | sampleuser@company.com |
contraseña | Sí | La contraseña del usuario que invoca el método API. | my_password |
configuración regional | No | Especifique la configuración regional que se utilizará para interpretar los números y las fechas de entrada, y para dar formato a los números y las fechas de salida (utilizando el separador de miles, los nombres de mes y el formato de fecha adecuados). La configuración regional también se utiliza para especificar el idioma en el que deben aparecer los mensajes del sistema en la respuesta. Si no se especifica, se utiliza en_US (inglés americano). | fr_FR |
instanceCode | No | Si el usuario especificado en las credenciales tiene acceso a más de una instancia de Adaptive Planning , este atributo se puede utilizar para especificar que el usuario tiene la intención de acceder a una instancia distinta a la instancia por defecto. Si no se especifica, se utilizará la instancia por defecto del usuario. Para determinar los códigos de instancia disponibles, utilice la API exportInstances. | MYINSTANCE1 |
Contenido del elemento | |||
(ninguno) | |||
elemento de nivel
| |||
Nombre de etiqueta
| nivel | ||
Descripción
| Especifica un nivel para crear. | ||
Atributos del elemento
| |||
parentId | Sí | El ID del nivel del que se va a crear este nivel como elemento secundario. | 34 |
nombre | Sí | El nombre del nivel. El nombre debe ser exclusivo. | Nombre de nuevo nivel |
shortName | No | El nombre corto del nivel. | NewLvName |
continuar - WithWarnings | No | Indica si el usuario desea ignorar los mensajes de aviso y continuar con la operación de creación. 0 para no, 1 para sí. Si hay avisos y procedaWithWarnings=0, el nivel no se creará. Defina procedaWithWarnings=1 para crear el nivel cuando haya avisos. | 1 |
Contenido del elemento
| |||
Un elemento de atributos opcional si desea definir uno o varios atributos de nivel asociados al nivel. | |||
elemento de atributos
| |||
Nombre de etiqueta
| atributos | ||
Descripción
| Contenedor para uno o varios elementos de atributo de nivel. | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿Obligatorio?
| Valor
| Ejemplo
|
(ninguno) | |||
Contenido del elemento
| |||
Uno o varios elementos de atributo | |||
elemento de atributo
| |||
Nombre de etiqueta
| atributo | ||
Descripción
| Contenedor para un elemento de atributo de nivel. | ||
Atributos del elemento
| |||
Nombre de atributo | ¿Obligatorio? | Valor | Ejemplo |
attributeID | Sí | El ID del atributo de nivel generado por el sistema. | 20 |
valueID | Sí | El ID exclusivo del valor de atributo de nivel generado por el sistema. Si este valor es 0, este atributo se elimina de la cuenta. | 170 |
Contenido del elemento
| |||
(ninguno) | |||
Formato de respuesta
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <levels> <level="41" name="New Level Name" shortName="NewLvlName" currency="USD"> <attribute attributeId="20" name="Regional Code" valueId="199" value="A-145" /> </level> </levels> </output> </response>
elemento de resultado
| |
Nombre de etiqueta
| salida |
Atributos del elemento
| |
(ninguno) | |
Contenido del elemento
| |
Un solo elemento de nivel obligatorio. Este contenedor de salida es estándar en todas las respuestas de API e incluye la salida válida de cualquier llamada API correcta. | |
elemento de niveles
| |||
Nombre de etiqueta
| niveles | ||
Descripción
| Contenedor para el elemento de nivel. | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿Obligatorio?
| Valor
| Ejemplo
|
Contenido del elemento
| |||
Uno o varios elementos de nivel Si la solicitud incluye niveles inaccesibles, solo habrá un elemento de nivel, que representa el nivel superior de la organización. | |||
elemento de nivel
| |||
Nombre de etiqueta
| nivel | ||
Descripción
| Representa un solo nivel de organización que se devuelve en la respuesta a una llamada a la API exportLevels. | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿Obligatorio?
| Valor
| Ejemplo
|
ID | Sí | El número de ID de sistema interno para el nivel. | 7 |
nombre | Sí | El nombre del nivel, tal como aparece en informes y hojas. | Desarrollo |
moneda | Sí | El código de moneda de la moneda asignada a este nivel de la organización. La moneda será una de las monedas configuradas para la instancia, que se encuentra en la llamada exportActiveCurrencies. | INR |
shortName | No | La abreviatura del nivel, si la hay, tal como se ha introducido en Administración de organización. | Dev |
availableStart | No | La fecha inicial de disponibilidad del nivel para la versión de cifras reales, aplicable solo cuando se especifica la versión de cifras reales en la solicitud. El valor puede ser un mes específico, con el formato "MM/AAAA", o el valor especial "START" que indica el inicio de la versión. | 01/2013 |
availableEnd | No | La fecha final de disponibilidad del nivel para la versión de cifras reales, aplicable solo cuando se especifica la versión de cifras reales en la solicitud. El valor puede ser un mes específico, con el formato "MM/AAAA", o el valor especial "FIN" que indica el final de la versión. | 12/2013 |
isImportable | No | Indica si el nivel asociado se puede importar en la versión especificada. '0' significa que no se puede importar y '1' significa que se puede importar. Un nivel se puede importar si se puede importar al menos un intervalo de tiempo de la versión especificada. El atributo isImportable solo se emite si se especifica versionName o versionID en la solicitud. Nota: isImportable solo indica que un nivel está disponible para importar en la versión especificada, no que el usuario que realiza la llamada a la API tenga permiso para importar a la versión o al nivel. Utilice exportVersions para ver qué versiones están disponibles para que el usuario las importe. | 1 |
workflowStatus | No | Emite el estado del workflow para el nivel asociado. I para "En curso", S para "Enviado", R para "Rechazado", A para "Aprobado" y L para "Bloqueado". Solo se incluye en la respuesta si el flujo de trabajo está activado para esta empresa y se especifica un versionName o versionID de planificación en la solicitud. El flujo de trabajo no está disponible en las versiones de cifras reales. | I |
isLinked | Sí | Indica si el nivel es un nivel vinculado. 0 para no, 1 para sí. | 1 |
isElimination | Sí | Indica si el nivel es un nivel de eliminación. 0 para no, 1 para sí. | 0 |
Contenido del elemento
| |||
Un elemento de nivel anidado para cada nivel secundario directo de este nivel. Un elemento de atributos si este nivel tiene uno o más atributos asociados. | |||
elemento de atributos
| |||
Nombre de etiqueta
| atributos | ||
Descripción
| Contenedor para uno o varios elementos de atributo. | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿Obligatorio?
| Valor
| Ejemplo
|
(ninguno) | |||
Contenido del elemento
| |||
Uno o varios elementos de atributo | |||
elemento de atributo
| |||
Nombre de etiqueta
| atributo | ||
Descripción
| Representa una sola asignación de atributo de nivel que no está en blanco a la que se asocia un nivel. | ||
Atributos del elemento
| |||
Nombre de atributo
| ¿ Obligatorio ? | Valor
| Ejemplo
|
nombre | Sí | El nombre del atributo de nivel | Descuento corporativo |
valor | Sí | El valor del atributo de nivel asociado al nivel. | Sí |
attributeID | Sí | El número de ID de sistema interno del atributo de nivel. | 20 |
valueID | Sí | El número de ID de sistema interno del valor de atributo de nivel. | 188 |
Contenido del elemento
| |||
(ninguno) | |||