Disponibilidad de hoja

Punto final de URL

VERB HTTP admitidos

OBTENER:

Solicitud:

/sheet/availability: Recupera una recopilación de disponibilidad de valor.

Recupera la disponibilidad de todos los valores de una dimensión de hoja. Puede filtrar por instanceCode, sheetName y columnName.

URI de solicitud de muestra:

HTTPS://api.adaptiveinsights.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=ExpenseCube&columnName=Level&columnType=Level

Cabecera de solicitud de muestra:

Accept-Language: es

Cuerpo de solicitud de muestra

Parámetros de consulta

Nombre	Descripción	Obligatorias
sheetName	El nombre de la hoja de la que se van a recuperar los valores de disponibilidad.	Sí
columnName	El nombre de la columna de hoja de la que se van a recuperar los valores de disponibilidad. Obligatorio solo para hojas de cubo. Solo se admiten las columnas en las que se puede modificar la disponibilidad del valor. En el caso de las columnas de cuenta y nivel de hoja de cubo, el nombre de la columna respeta la configuración regional definida en la cabecera Accept-Language.	Sí
columnCode	El código de la columna de hoja de la que se van a recuperar los valores de disponibilidad. Obligatorio solo para hojas modeladas. Solo se admiten las columnas en las que se puede modificar la disponibilidad del valor.	Sí
columnType	El tipo de columna para el columnName o columnCode dados. Valores aceptables: cuenta, nivel, dimensión, atributo	Sí
instanceCode	El instanceCode de donde se van a recuperar los valores. Por ejemplo, GLOBO. Si no se especifica instanceCode, se utiliza la instancia por defecto del usuario.	No
limit	El número máximo de objetos en una sola respuesta.	No
offset	El índice de base cero del primer objeto de una recopilación de respuestas. El valor por defecto es 0. Utilice la compensación con el parámetro limit para controlar la paginación de una recopilación de respuestas.	No

Respuesta de muestra

200

Respuesta correcta.

Respuesta de muestra

{ "data": [ { "code": "Corporate Plan", "name": "Corporate Plan", "available": true }, { "code": "Engineering", "name": "Engineering", "available": true }, { "code": "Development", "name": "Development", "available": true }, { "code": "Documentation", "name": "Documentation", "available": true }, { "code": "QA", "name": "QA", "available": true }, { "code": "2014-Development Organization", "name": "2014-Development Organization", "available": false }, { "code": "Development-India", "name": "Development-India", "available": false }, { "code": "QA-India", "name": "QA-India", "available": false }, { "code": "G & A", "name": "G & A", "available": false }, { "code": "Hosting", "name": "Hosting", "available": true }, { "code": "Professional Services", "name": "Professional Services", "available": true }, { "code": "Sales", "name": "Sales", "available": true }, { "code": "Marketing", "name": "Marketing", "available": true }, { "code": "US Sales", "name": "US Sales", "available": false }, { "code": "Worldwide Sales", "name": "Worldwide Sales", "available": true }, { "code": "Asia Sales", "name": "Asia Sales", "available": false }, { "code": "Europe Sales", "name": "Europe Sales", "available": true }, { "code": "Latin America Sales", "name": "Latin America Sales", "available": true } ], "total": 18 }

POST:

Solicitud:

/sheet/availability: Actualiza una recopilación de disponibilidad de valor.

Actualiza la disponibilidad de todos los valores de una dimensión de hoja.

URI de solicitud de muestra:

https://api.adaptiveplanning.com/api/rest/modeling/v1/globosales/sheet/availability?sheetName=ExpenseCube&columnName=Level&columnType=Level

Cabecera de solicitud de muestra:

Accept-Language: es

Cuerpo de solicitud:

Matriz JSON de objetos de disponibilidad que coinciden con la propiedad "data" de la exportación. Cada objeto JSON tiene la siguiente estructura:

Nombre	Descripción	Obligatorias
código	Código del valor. Se utiliza para identificar valores de forma exclusiva.	Sí
nombre	Nombre del valor.	Sí
accountGroup	Si el valor es un grupo de cuentas. Obligatorio para las cuentas.	No
disponible	Si el valor está disponible o no. Si no está presente, no se realiza ningún cambio.	No
deleteIfDataIsPresent	Si se eliminan los datos, si están presentes. Obligatorio al desactivar un valor de dimensión personalizada en hojas de cubo.	No
actionIfDataIsPresent	La acción que se debe realizar cuando hay datos presentes. Obligatorio al desactivar un valor de dimensión personalizada en hojas modeladas.	No

Cuerpo de solicitud de muestra

Cuerpo de solicitud

[ { "code": "SalesCube.DiscountPercent", "name": "Discount Percent", "accountGroup": false, "available": false } ]

Parámetros de consulta

Nombre	Descripción	Obligatorias
sheetName	El nombre de la hoja de la que se recuperarán los valores de disponibilidad.	Sí
columnName	el nombre de la columna de hoja de la que se van a recuperar los valores de disponibilidad. Obligatorio solo para hojas de cubo. Solo se admiten las columnas en las que se puede modificar la disponibilidad del valor. En el caso de las columnas de cuenta y nivel de hoja de cubo, el nombre de la columna respeta la configuración regional definida en la cabecera Accept-Language.	Sí
columnCode	El código de la columna de hoja de la que se recuperará la disponibilidad. Obligatorio solo para hojas modeladas. Solo se admiten las columnas en las que se puede modificar la disponibilidad del valor.	Sí
columnType	El tipo de columna para el columnName o columnCode dados. Valores aceptables: cuenta, nivel, dimensión y atributo.	Sí
instanceCode	El instanceCode de donde se van a recuperar los valores. Por ejemplo, GLOBO. Si no se especifica instanceCode, se utiliza la instancia por defecto del usuario.	No

Ejemplo de respuesta:

204

La respuesta correcta está en blanco con el código de estado 204.