Get Outline Code By Index

Introduction

This example allows you to get Outline Code by index using Aspose.Tasks Cloud API in your applications. You can use our REST API with any language: .NET, Java, PHP, Ruby, Rails, Python, Objective C, jQuery and many more.

API Information

API	Type	Description	Resource Link
/tasks/{name}/outlineCodes/{index}	GET	Read outline codes by index information from a MS Project file	GetOutlineCodeByIndex

cURL Example

Request


curl -X GET "https://api.aspose.cloud/v3.0/tasks/Home%20move%20plan.mpp/outlineCodes/1" -H "accept: application/json"

Response


{
  "code": 0,
  "status": "string",
  "outlineCode": {
    "guid": "string",
    "fieldId": "string",
    "fieldName": "string",
    "alias": "string",
    "phoneticAlias": "string",
    "values": [
      {
        "valueId": 0,
        "fieldGuid": "string",
        "type": "Null",
        "parentValueId": 0,
        "value": "string",
        "description": "string",
        "isCollapsed": true
      }
    ],
    "enterprise": true,
    "enterpriseOutlineCodeAlias": 0,
    "resourceSubstitutionEnabled": true,
    "leafOnly": true,
    "allLevelsRequired": true,
    "onlyTableValuesAllowed": true,
    "masks": [
      {
        "level": 0,
        "type": "Null",
        "length": 0,
        "separator": "string"
      }
    ],
    "showIndent": true
  }
}

SDKs

The Aspose.Tasks Cloud SDKs can be downloaded from the following page: Available SDKs

SDK Examples

	// For complete examples and data files, please go to https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-dotnet/
	var remoteName = await UploadFileToStorageAsync("NewProductDev.mpp");

	var response = await TasksApi.GetOutlineCodeByIndexAsync(new GetOutlineCodeByIndexRequest
	{
	Index = 1,
	Name = remoteName,
	Folder = this.DataFolder
	});

	Assert.AreEqual((int)HttpStatusCode.OK, response.Code);
	Assert.IsNotNull(response.OutlineCode);
	Assert.AreEqual("F45D601B-70C5-E311-A5BA-D43D7E937F92", response.OutlineCode.Guid);

view raw Examples-GetOutlineCodeByIndex.cs hosted with ❤ by GitHub

PHP

	<?
	// For complete examples and data files, please go to https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-php/
	$remoteName = "GetOutlineCode.mpp";
	$folder = $this->uploadFile("NewProductDev.mpp", $remoteName, '');

	$response = $this->tasks->getOutlineCodeByIndex(new Requests\GetOutlineCodeByIndexRequest($remoteName, 1, self::$storageName, $folder));
	Assert::assertEquals(200, $response->getCode());
	Assert::assertNotNull($response->getOutlineCode());
	Assert::assertEquals("F45D601B-70C5-E311-A5BA-D43D7E937F92", $response->getOutlineCode()->getGuid());

view raw Example-getOutlineCodeByIndex.php hosted with ❤ by GitHub

Python

	# For complete examples and data files, please go to https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-python
	filename = 'NewProductDev.mpp'
	self.upload_file(filename)
	get_request = GetOutlineCodeByIndexRequest(filename, 1)
	get_result = self.tasks_api.get_outline_code_by_index(get_request)
	self.assertIsNotNone(get_result)
	self.assertIsInstance(get_result, OutlineCodeResponse)
	self.assertEqual('F45D601B-70C5-E311-A5BA-D43D7E937F92', get_result.outline_code.guid)

view raw get_outline_code_by_index.py hosted with ❤ by GitHub

Node.js

	// For complete examples and data files, please go to https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-node

	const fileName = "NewProductDev.mpp";
	const localPath = "./Data/" + fileName;
	const remotePath = "Temp/Data";
	const remoteFullPath = remotePath + "/" + fileName;

	await tasksApi.uploadFileToStorage(remoteFullPath, localPath);

	const request = new GetOutlineCodeByIndexRequest();
	request.name = fileName;
	request.folder = remotePath;
	request.index = 1;

	const result = await tasksApi.getOutlineCodeByIndex(request);

	expect(result.response.statusCode).to.equal(200);
	expect(result.body.outlineCode).not.undefined.and.not.null;
	expect(result.body.outlineCode.guid).to.equal("F45D601B-70C5-E311-A5BA-D43D7E937F92");

view raw getOutlineCodeByIndex.ts hosted with ❤ by GitHub

	// For complete examples and data files, please go to https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-go/
	client, ctx := UploadTestFileToStorage(t, localFileName, remoteBaseTestDataFolder+"/"+remoteFileName)

	options := &requests.GetOutlineCodeByIndexOpts{
	Name: remoteFileName,
	Folder: optional.NewString(remoteBaseTestDataFolder),
	Index: 1,
	}

	result, _, err := client.TasksApi.GetOutlineCodeByIndex(ctx, options)

	if err != nil {
	t.Error(err)
	}
	assert.Equal(t, int32(200), result.Code)
	assert.NotNil(t, result.OutlineCode)
	assert.Equal(t, "F45D601B-70C5-E311-A5BA-D43D7E937F92", result.OutlineCode.Guid)

view raw Examples-GetOutlineCodeByIndex.go hosted with ❤ by GitHub

Java

	// For complete examples and data files, please go to https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-java/
	String localFileName = "NewProductDev.mpp";
	String remoteFileName = TestInitializer.UploadFile(localFileName);

	GetOutlineCodeByIndexRequest request = new GetOutlineCodeByIndexRequest(remoteFileName, 1, null, null);
	OutlineCodeResponse result = TestInitializer.tasksApi.getOutlineCodeByIndex(request);
	assertNotNull(result);
	assertEquals(200, (int) result.getCode());
	assertNotNull(result.getOutlineCode());
	assertEquals("F45D601B-70C5-E311-A5BA-D43D7E937F92", result.getOutlineCode().getGuid());

view raw Examples-GetOutlineCodeByIndex.java hosted with ❤ by GitHub

Get Outline Codes Information Delete A Project Outline Code