Uploader Service API

To access the ULS, use one of the following UrLs, depending on the region in which the upload is taking place

• North America - https://datalink.apptio.com/uls
• EU - https://datalink-eu.apptio.com/uls
• APAC - https://datalink-au.apptio.com/uls
• Middle East - https://datalink-me.apptio.com/uls

To authenticate, you must first obtain an apptio-opentoken.

1. Go to Enhanced Access Administration APIs to retrieve an Apptio opentoken.
2. After you have the token, add following headers to your request:

The APIs support the following operations:

• single-part upload
• multi-part upload
• processing upload
• get processing status

To form the single-part body, following parts need be present:

"metadata": ( { "name": "<TABLE_NAME>" } )
"data": ()

Body:

{
	"name":"<TABLE_NAME>"
}

{
	"uploadId":""<UPLOAD_ID>", 
	"multipartId":"<MULTIPART_ID>"
}

Method:

POST <ULS_URL>/v1/process

Content-type: application/json

Processes with single upload or uploads have the same metadata:

{
	"metadata": {
		"period": "<Apptio time period e.g. Jan:FY2018>",
		"domain": "<Customer domain e.g. customer.apptio.com>",
		"name": "<File name e.g. file.tsv, file.zip, etc.>",
		"host": "<Apptio host name>",
		"format": "<File format e.g. tsv, csv, etc.>",
		"project": "<Project Name>",
		"source": "<Data source e.g. S3>",
		"category": "<Optional category name>",
		"branch": "<Optional branch name>",
		"overwrite": "<true or false to append>",
		"autoCheckin":"<true of false to check in BIIT>"
	},
	"uploadIds": [
		"<UPLOAD ID>"
	]
}

For multiple uploads with different metadata:

{
	"metadata": {
		"period": "<Apptio time period e.g. Jan:FY2018>",
		"domain": "<Customer domain e.g. customer.apptio.com>",
		"name": "<File name e.g. file.tsv, file.zip, etc.>",
		"host": "<Apptio host name>",
		"format": "<File format e.g. tsv, csv, etc.>",
		"project": "<Project Name>",
		"source": "<Data source e.g. S3>",
		"category": "<Optional category name>",
		"branch": "<Optional branch name>",
		"overwrite": "<true or false to append>"
		"autoCheckin": "<true of false to check in BIIT>"
	},
	"uploadIds": [
		"<UPLOAD_ID1>",
		"<UPLOAD_ID2>"
	],
	"uploadTargetMapping": {
		"<UPLOAD_ID1>": {
			"period": "<Apptio time period e.g. Jan:FY2018>",
			"domain": "<Customer domain e.g. customer.apptio.com>",
			"name": "<File name e.g. file.tsv, file.zip, etc.>",
			"host": "<Apptio host name>",
			"format": "<File format e.g. tsv, csv, etc.>",
			"project": "<Project Name>",
			"source": "<Data source e.g. S3>",
			"category": "<Optional category name>",
			"branch": "<Optional branch name>",
			"overwrite": "<true or false to append>"g
			"autoCheckin": "<true of false to check in BIIT>"
		},
		"<UPLOAD_ID1>": {
			"period": "<Apptio time period e.g. Jan:FY2018>",
			"domain": "<Customer domain e.g. customer.apptio.com>",
			"name": "<File name e.g. file.tsv, file.zip, etc.>",
			"host": "<Apptio host name>",
			"format": "<File format e.g. tsv, csv, etc.>",
			"project": "<Project Name>",
			"source": "<Data source e.g. S3>",
			"category": "<Optional category name>",
			"branch": "<Optional branch name>",
			"overwrite": "<true or false to append>"
			"autoCheckin": "<true of false to check in BIIT>"
		}
	}
}

Response (JSON):

{
	"processId": "<PROCESS_ID>"
}

Response (JSON):

{
	"statuses": [
		{
			  "processId": "<PROCESS_ID>",
			  ...,
			  "statusMap": {
				   "<status map ID>": {
					    "statusCode": "<Status e.g. NotStarted, Finished, etc.>",
					    "errorCode": “<Error if any>”,
					    "detail": “<Details>”,
					    "tableName": "<Table name>",
					    "lastModified": "<Last modified date>"
				    }
			   }
		}
	]
}

When you use this API call to upload to an R12 project where the target table doesn't yet exist, Apptio creates the table and installs the data in the first time period regardless of the time period specified in the API call. This only applies to the first upload to a table that doesn't yet exist. All subsequent calls honor the date specified. The reason for this behavior is to ensure that columns are present in the first time period. If you want to have no data present until a specific time period, then you can either create the table manually, or after the initial upload, do the following:

1. Download the data initially uploaded via the Apptio UI.
2. Create a file which just includes the header.
3. Upload the header to the first time period in the project.
4. Upload the data downloaded in step 1 to the desired time period.