内部身份识别号参考
您可以在 API 请求中包括内部编号,以获取用于 create、update 和 Read 方法的元数据。当您使用这些方法发出请求时,请使用关联的导出 API 调用来获取您的请求所需的编号。下表中所有 API 的请求都需要凭据元素。
示例
您必须传递维度编号,才能在 updateDimensionsAPI 请求中更新维度。您可以传递维度编号“7”来更新维度“教育
背景”。
<dimensions> <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0"> -------------------------- </dimension> </dimensions>
从 exportDimensionsAPI 响应中获取“教育背景”的维度编号“7”。
<response success="true"> <output> <dimensions> <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="1" seqNo="35"> -------------------------------------------- </dimension> </output> </response>
导出 API 和响应编号
API | Adaptive Planning 响应中的内部编号 | 检索的元数据 |
|---|---|---|
账户编号和账户属性编号
账号可用于在其他 API 调用(例如 exportDimensionFamilies)中识别账户。 “工作表元素”为选填项。如果包括工作表元素,则必须在请求中传递工作表的内部系统编号。请参见 exportSheets。 | 所有账户的列表,包括所有账户类型:假设、多维账户、自定义账户、总分类账账户、指标账户和模型化账户。 | |
维度编号及其 dimensionValue 元素编号 这可用于在其他 API 调用(例如 exportDimensionFamilies)中识别维度。 | 系统中所有维度的列表。 | |
角色编号 此字段用于识别在 exportUsers API 调用中指定给用户的角色。 | 实例中所有角色的列表。 | |
工作表编号(可以是标准工作表、多维工作表和模型化工作表元素) 这可用于在其他 API 调用(例如 exportSheetDefinition)中标识工作表。 | 为给定实例定义的所有工作表的列表。这包括“不完整”的工作表和按用户指定的工作表。 | |