笔记：While all of these scripts have been tested and found to be fully functional, due to the vast amount of potential use cases, Anaplan does not explicitly support custom scripts built by our customers. This article is for information only and does not suggest any future product direction.
Python(If you are using a Python version older or newer than 3.6.4, or requests version older or newer than 2.18.4, we cannot guarantee the validity of the article.)
JSON(Note: Install instructions are not at this site but will be the same as any other Python module.)
笔记：Please read the comments at the top of every script before use, as they more thoroughly detail the assumptions that each script makes.
Authentication
To start, let's talk about Authentication. Every script run that connects to our API will be required to supply valid authentication. There are two ways to authenticate a Python script that I will be covering.
To be used with the API, the PEM certificate string will need to be converted to base64, but the scripts we will be covering will take care of that for you, so I won't cover that in this section.
# Insert the Anaplan account email being used username = '' ----------------- # If using cert auth, replace cert.pem with your pem converted certificate # filename. Otherwise, remove this line. cert = open('cert.pem').read() # If using basic auth, insert your password. Otherwise, remove this line. password = '' # Uncomment your authentication method (cert or basic). Remove the other. user = 'AnaplanCertificate ' + str(base64.b64encode(( f'{username}:{cert}').encode('utf-8')).decode('utf-8')) # user = 'Basic ' + str(base64.b64encode((f'{username}:{password}' # ).encode('utf-8')).decode('utf-8')
If you are using basic authentication, you will need to set the password variable to your Anaplan account password, and you can remove the cert line, its comments, and its respective user variable.
Getting the Information Needed for Each Script
本文涵盖的大多数脚本将要求您知道您正在尝试处理的文件，操作等的ID或元数据。每个获取此信息的脚本都标题为get_____.py。For example, if you want to get your file's metadata, you'll rungetfiles.py，它将在选定模型，选定的工作区，阵列中为JSON文件中的每个文件编写文件元数据files.json。You can then open the JSON file, find the file you need to reference, and use the metadata from that entry in your other scripts.
提示：If you open the raw data tab of the JSON file it makes it much easier to copy the whole set of metadata.
以下是下载的链接get____.py脚本。每个得到脚本使用requests.getmethod to send a get request to the proper API endpoint.
得到Workspaces.py：Writes an array toworkspaces.json在用户可以访问的所有工作区中。
得到Models.py：Writes an array to模特of either all the models a user has access to ifwguidis left blank or all of the models the user has access to in a selected workspace if a workspace ID was inserted.
得到ModelInfo.py：Writes an array tomodelinfo.json与所选模型关联的所有元数据。
getfiles.py：Writes an array tofiles.jsonof all metadata for each file the user has access to in the selected model and workspace. (Please refer to养蜂场有关私人与默认文件的更多信息。通常，建议所有脚本通过同一用户帐户运行。）
得到ChunkData.py：Writes an array tochunkdata.jsonof all metadata for each chunk of the selected file in the selected model and workspace.
getimports.py：Writes an array toimports.jsonof all metadata for each import in the selected model and workspace.
得到出口。py：Writes an array toexports.json所选模型和工作区中每个导出的所有元数据。
getactions.py：Writes an array toactions.jsonof all metadata for all actions in the selected model and workspace.
得到过程。py：Writes an array toprocess.jsonof all metadata for all processes in the selected model and workspace.
Uploads
A file can be uploaded to the Anaplan API endpoint either in chunks or as a single chunk. Per our apiary:
We recommend that you upload files in several chunks. This enables you to resume an upload that fails before the final chunk is uploaded. In addition, you can compress files on the upload action. We recommend compressing single chunks that are larger than 50MB. This creates a Private File.
笔记：上传一个文件使用的API,文件必须存在t in Anaplan. If the file has not been previously uploaded, you must upload it initially using the Anaplan user interface. You can then carry out subsequent uploads of that file using the API.
多个块上传
这script we have for reference is built so that if the script is interrupted for any reason, or if any particular chunk of a file fails to upload, simply rerunning the script will start uploading the file again, starting at the last successful chunk. For this to work, the file must be initially split using a standard naming convention, using the terminal script below.
split -b [numberofBytes] [path and filename] [prefix for output files]
You can store the file in any location as long as you the proper file path when setting thechunkFilePrefix(e.g.chunkfileprefix =''upload_chunks/块 - ”这将寻找名称的文件块大块，，，，块，，，，大块etc., up to块在文件夹中script_origin/upload_chunks/。您不太可能超越块）。这将使脚本知道在哪里查找文件的块要上传。您可以下载脚本以从此链接运行多个块上传：chunkupload.py。
笔记：这chunkupload.pyscript keeps track of the last successful chunk by writing the name of the last successful chunk to a .txt filechunkStop.txt。This file is deleted once the import completes successfully. If the file is modified in between runs of the script, the script may not function correctly. Best practice is to leave the file alone and delete it if you want to start the upload from the first chunk.
导入完成后，脚本将在数组中为导入任务编写元数据Postimport.json，您可以使用哪些任务来验证要查看运行时的状态importStatus.py脚本。这importStatus.py脚本将返回与所选expertid及其各自列表索引相关的所有任务的列表。如果您想检查上一次运行导入的状态，请确保您正在检查Postimport.jsonto verify you have the correct taskID. Enter the index for the task and the script will write the task status to an array in fileimportStatus.json。如果任务仍在进行中，它将打印任务状态和进度。如果任务完成和故障转储可用，它将以逗号分隔格式写入失败转储importDump.csv可用于审查失败的原因。If the task finished with no failures, you will get a message telling you the import has completed with no failures. You can download the script forimportStatus.py从此链接：importStatus.py
笔记：If you check the status of a task with an old taskID for an import that has been run since you last checked it, the dump will no longer exist andimportDump.csv将被HTTP错误覆盖，任务的状态将为410 Gone。
导出完成后，脚本将在数组中为导出任务编写元数据Postexport.json，您可以使用哪些任务来验证要查看运行时的状态exportstatus.py脚本。这exportstatus.py脚本将返回与所选exportid关联的所有任务及其各自列表索引的列表。如果您想检查上一次运行导入的状态，请确保您正在检查Postexport.jsonto verify you have the correct taskID. Enter the index for the task and the script will write the task status to an array in fileexportStatus.json。如果任务仍在进行中，它将打印任务状态和进度。重要的是要注意，如果导出失败，将不会生成故障转储。您可以下载脚本exportstatus.py从此链接：exportstatus.py
动作
这action.pyscript sends a post request to the API endpoint for the selected action (for use with actions other than imports or exports). You will need to set the actionData value to the metadata for the action. SeeGetting the Information Needed for Each Script想要查询更多的信息。您可以下载脚本以从此链接中运行操作：ActionStatus.py。
过程
这process.pyscript sends a post request to the API endpoint for the selected process. You will need to set the processData value to the metadata for the process. SeeGetting the Information Needed for Each Script想要查询更多的信息。您可以下载脚本running a process from this link:process.py。
该过程完成后，脚本将在数组中为过程任务编写元数据后进程，您可以使用哪些任务来验证要查看运行时的状态processStatus.py脚本。这processStatus.pyscript will return a list of all tasks associated with the selected processID and their respective list index. If you are wanting to check the status of the last run import, make sure you are checking后进程to verify you have the correct taskID. Enter the index for the task and the script will write the task status to an array in fileProcessStatus.json。如果任务仍在进行中，它将打印任务状态和进度。如果任务完成和故障转储可用，它将以逗号分隔格式写入失败转储ProcessDump.CSV可用于审查失败的原因。重要的是要注意，只有在该过程中的一个导入失败时，该过程本身不会生成故障转储。如果任务没有失败完成，您将收到一条消息，告诉您该过程已经完成而没有失败。您可以下载脚本processStatus.py从此链接：processStatus.py.
下载文件
从Anaplan API端点下载文件将在端点上存在的许多块中下载文件。重要的是要注意，您应该设置变量文件名到name它在文件元数据中具有。首先，下载单个块元数据将以一个数组写成downloadChunkData.jsonfor reference. The script will then download the file chunk by chunk and write each chunk to a new local file with the same name as the 'name' listed in the file's metadata. You can download the link for this script from this link:downloadfile.py。
笔记：如果文件已经与您的脚本相同的文件夹中存在，则名称与namevalue in the file's metadata, the local file will be overwritten with the file being downloaded from the server.
删除文件
You can delete the file contents of any file that the user has access to that exists in the Anaplan server.笔记：这只会删除私人内容。默认内容和导入数据源模型对象将保留。You can download the link for this script from this link:deletefile.py。
Standalone Requests Code and Their Required Headers
In this section, I will list the code for each request detailed above, including the API URL and the headers necessary to complete the call. I will be leaving the content right of授权：headers blank. Authorization header values can be either基本Encoded_username：密码oranaplancertificate encoded_commonname：pem_certificate_string（看证书授权 - 使用的Anaplan-Api有关编码证书的更多信息）
笔记：requests.getwill only generate a response body from the server, and no data will be locally saved unless written to a local file.
这content in this article has not been evaluated for all Anaplan implementations and may not be recommended for your specific situation. Please consult your internal administrators prior to applying any of the ideas or steps in this article.
