Add a new Extended Attribute definition to a Project

Introduction

This example allows you to add a new extended attribute in a project using Aspose.Tasks Cloud API in your applications. You can use our REST API with any language: .NET, Java, PHP, Ruby, Rails, Python, jQuery and many more.

API Information

API	Type	Description	Resource Link
/tasks/{name}/extendedAttributes	PUT	Add a new extended attribute definition to a project or updates existing attribute definition	PutExtendedAttribute

cURL Example

Request


curl -X PUT "https://api.aspose.cloud/v3.0/tasks/NewProductDev.mpp/extendedAttributes" -H "accept: application/json" -H "Content-Type: application/json" -H "x-aspose-client: Containerize.Swagger" -d "{ \"fieldId\": \"string\", \"fieldName\": \"Text3\", \"cfType\": \"Text\", \"guid\": \"string\", \"elementType\": \"Task\", \"maxMultiValues\": 0, \"userDef\": true, \"alias\": \"New Field\", \"secondaryPid\": \"string\", \"autoRollDown\": true, \"defaultGuid\": \"string\", \"lookupUid\": \"string\", \"phoneticsAlias\": \"string\", \"rollupType\": \"Null\", \"calculationType\": \"Lookup\", \"formula\": \"string\", \"restrictValues\": true, \"valuelistSortOrder\": 0, \"appendNewValues\": true, \"default\": \"string\", \"valueList\": [ { \"id\": 111, \"val\": \"Internal\", \"dateTimeValue\": \"2020-09-19T10:38:41.713Z\", \"durationValue\": 0, \"description\": \"descr1\", \"phonetic\": \"string\" }, { \"id\": 112, \"val\": \"External\", \"dateTimeValue\": \"2020-09-19T10:38:41.713Z\", \"durationValue\": 0, \"description\": \"descr2\", \"phonetic\": \"string\" } ], \"secondaryGuid\": \"string\"}"

Response


{
  "code": 0,
  "status": "string",
  "extendedAttribute": {
    "link": {
      "href": "string",
      "rel": "string",
      "type": "string",
      "title": "string"
    },
    "index": 0,
    "fieldName": "string",
    "alias": "string",
    "fieldId": "string"
  }
}

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 newExtendedAttribute = new ExtendedAttributeDefinition
	{
	CalculationType = CalculationType.Lookup,
	CfType = CustomFieldType.Text,
	FieldName = "Text3",
	ElementType = ElementType.Task,
	Alias = "New Field",
	ValueList = new List<Value>
	{
	new Value { Description = "descr1", Val = "Internal", Id = 111 },
	new Value { Description = "descr2", Val = "External", Id = 112 }
	}
	};

	var response = await TasksApi.PutExtendedAttributeAsync(new PutExtendedAttributeRequest
	{
	ExtendedAttribute = newExtendedAttribute,
	Name = remoteName,
	Folder = this.DataFolder
	});

	Assert.AreEqual((int)HttpStatusCode.OK, response.Code);
	Assert.IsNotNull(response.ExtendedAttribute);

	Assert.AreEqual("Text3", response.ExtendedAttribute.FieldName);
	Assert.AreEqual("New Field", response.ExtendedAttribute.Alias);
	Assert.AreEqual("188743737", response.ExtendedAttribute.FieldId);

view raw Examples-PutExtendedAttribute.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 = "AddExtendedAttributeDefinition.mpp";
	$folder = $this->uploadFile("NewProductDev.mpp", $remoteName, '');

	$newExtendedAttribute = new Model\ExtendedAttributeDefinition();
	$newExtendedAttribute->setCalculationType(CalculationType::LOOKUP);
	$newExtendedAttribute->setCfType(Model\CustomFieldType::TEXT);
	$newExtendedAttribute->setFieldName("Text3");
	$newExtendedAttribute->setElementType(Model\ElementType::TASK);
	$newExtendedAttribute->setAlias("New Field");

	$value1 = new Model\Value();
	$value1->setDescription("descr1");
	$value1->setVal("Internal");
	$value1->setId(111);

	$value2 = new Model\Value();
	$value2->setDescription("descr2");
	$value2->setVal("External");
	$value2->setId(112);
	$newExtendedAttribute->setValueList(array($value1, $value2));

	$response = $this->tasks->putExtendedAttribute(new Requests\PutExtendedAttributeRequest($remoteName, $newExtendedAttribute, null, self::$storageName, $folder));

	Assert::assertEquals(200, $response->getCode());
	Assert::assertNotNull($response->getExtendedAttribute());
	Assert::assertEquals("Text3", $response->getExtendedAttribute()->getFieldName());
	Assert::assertEquals("New Field", $response->getExtendedAttribute()->getAlias());
	Assert::assertEquals("188743737", $response->getExtendedAttribute()->getFieldId());


	$addedAttributeIndex = $response->getExtendedAttribute()->getIndex();

	$response = $this->tasks->getExtendedAttributeByIndex(new Requests\GetExtendedAttributeByIndexRequest($remoteName, $addedAttributeIndex, self::$storageName, $folder));
	Assert::assertEquals(200, $response->getCode());
	Assert::assertNotNull($response->getExtendedAttribute());
	$extendedAttribute = $response->getExtendedAttribute();

	Assert::assertEquals("188743737", $extendedAttribute->getFieldId());
	Assert::assertEquals("Text3", $extendedAttribute->getFieldName());
	Assert::assertEquals(Model\CustomFieldType::TEXT, $extendedAttribute->getCfType());
	Assert::assertEquals("New Field", $extendedAttribute->getAlias());
	$valueList = $extendedAttribute->getValueList();
	Assert::assertEquals(2, count($valueList));

	Assert::assertEquals(111, $valueList[0]->getId());
	Assert::assertEquals("Internal", $valueList[0]->getVal());
	Assert::assertEquals("descr1", $valueList[0]->getDescription());

	Assert::assertEquals(112, $valueList[1]->getId());
	Assert::assertEquals("External", $valueList[1]->getVal());
	Assert::assertEquals("descr2", $valueList[1]->getDescription());

view raw Example-putExtendedAttribute.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)
	first_value = Value()
	first_value.description = "descr1"
	first_value.val = "Internal"
	first_value.id = 111
	second_value = Value()
	second_value.description = "descr2"
	second_value.val = "External"
	second_value.id = 112
	new_extended_attribute = ExtendedAttributeDefinition()
	new_extended_attribute.calculation_type = CalculationType.LOOKUP
	new_extended_attribute.cf_type = CustomFieldType.TEXT
	new_extended_attribute.field_name = "Text3"
	new_extended_attribute.element_type = ElementType.TASK
	new_extended_attribute.alias = "New Field"
	new_extended_attribute.value_list = [first_value, second_value]
	put_request = PutExtendedAttributeRequest(new_extended_attribute, filename)
	put_result = self.tasks_api.put_extended_attribute(put_request)
	self.assertIsNotNone(put_result)
	self.assertIsInstance(put_result, ExtendedAttributeItemResponse)
	self.assertIsNotNone(put_result.extended_attribute)
	self.assertEqual('Text3', put_result.extended_attribute.field_name)
	self.assertEqual('New Field', put_result.extended_attribute.alias)
	self.assertEqual('188743737', put_result.extended_attribute.field_id)
	added_attribute_index = put_result.extended_attribute.index
	get_request = GetExtendedAttributeByIndexRequest(filename, added_attribute_index)
	get_result = self.tasks_api.get_extended_attribute_by_index(get_request)
	self.assertIsNotNone(get_result)
	self.assertIsInstance(get_result, ExtendedAttributeResponse)
	self.assertIsNotNone(get_result.extended_attribute)
	self.assertEqual('Text3', get_result.extended_attribute.field_name)
	self.assertEqual('New Field', get_result.extended_attribute.alias)
	self.assertEqual('188743737', get_result.extended_attribute.field_id)
	self.assertEqual(CustomFieldType.TEXT, get_result.extended_attribute.cf_type)
	self.assertEqual(2, len(get_result.extended_attribute.value_list))
	self.assertEqual(111, get_result.extended_attribute.value_list[0].id)
	self.assertEqual('Internal', get_result.extended_attribute.value_list[0].val)
	self.assertEqual('descr1', get_result.extended_attribute.value_list[0].description)
	self.assertEqual(112, get_result.extended_attribute.value_list[1].id)
	self.assertEqual('External', get_result.extended_attribute.value_list[1].val)
	self.assertEqual('descr2', get_result.extended_attribute.value_list[1].description)

view raw put_extended_attribute.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 firstValue = new Value();
	firstValue.description = "descr1";
	firstValue.val = "Internal";
	firstValue.id = 111;
	const secondValue = new Value();
	secondValue.description = "descr2";
	secondValue.val = "External";
	secondValue.id = 112;
	const newExtendedAttribute = new ExtendedAttributeDefinition
	newExtendedAttribute.calculationType = CalculationType.Lookup,
	newExtendedAttribute.cfType = CustomFieldType.Text,
	newExtendedAttribute.fieldName = "Text3",
	newExtendedAttribute.elementType = ElementType.Task,
	newExtendedAttribute.alias = "New Field",
	newExtendedAttribute.valueList = [firstValue, secondValue];

	const request = new PutExtendedAttributeRequest();
	request.name = fileName;
	request.folder = remotePath;
	request.extendedAttribute = newExtendedAttribute;

	const result = await tasksApi.putExtendedAttribute(request);

	expect(result.response.statusCode).to.equal(200);
	expect(result.body.extendedAttribute).not.undefined.and.not.null;

view raw putExtendedAttribute.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)
	firstValue := models.Value{
	Description: "descr1",
	Val: "Internal",
	Id: 111,
	}
	secondValue := models.Value{
	Description: "descr2",
	Val: "External",
	Id: 112,
	}
	newCalculationType := models.LOOKUP_CalculationType
	newCfType := models.TEXT_CustomFieldType
	newElementType := models.TASK_ElementType
	newRollupType := models.NULL_RollupType
	newExtendedAttribute := models.ExtendedAttributeDefinition{
	CalculationType: &newCalculationType,
	CfType: &newCfType,
	ElementType: &newElementType,
	RollupType: &newRollupType,
	FieldName: "Text3",
	Alias: "New Field",
	ValueList: []models.Value{firstValue, secondValue},
	}

	putResult, _, err := client.TasksApi.PutExtendedAttribute(ctx, &requests.PutExtendedAttributeOpts{
	Name: remoteFileName,
	Folder: optional.NewString(remoteBaseTestDataFolder),
	ExtendedAttribute: newExtendedAttribute,
	})
	if err != nil {
	t.Error(err)
	}
	assert.Equal(t, int32(200), putResult.Code)
	assert.NotNil(t, putResult.ExtendedAttribute)
	assert.Equal(t, newExtendedAttribute.FieldName, putResult.ExtendedAttribute.FieldName)
	assert.Equal(t, newExtendedAttribute.Alias, putResult.ExtendedAttribute.Alias)
	assert.Equal(t, "188743737", putResult.ExtendedAttribute.FieldId)

view raw Examples-PutExtendedAttribute.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);

	Value firstValue = new Value();
	firstValue.setDescription("descr1");
	firstValue.setVal("Internal");
	firstValue.setId(111);
	Value secondValue = new Value();
	secondValue.setDescription("descr2");
	secondValue.setVal("External");
	secondValue.setId(112);
	ExtendedAttributeDefinition newExtendedAttribute = new ExtendedAttributeDefinition();
	newExtendedAttribute.setCalculationType(CalculationType.LOOKUP);
	newExtendedAttribute.setCfType(CustomFieldType.TEXT);
	newExtendedAttribute.setFieldName("Text3");
	newExtendedAttribute.setElementType(ElementType.TASK);
	newExtendedAttribute.setAlias("New Field");
	newExtendedAttribute.setValueList(Arrays.asList(firstValue, secondValue));
	PutExtendedAttributeRequest request1 = new PutExtendedAttributeRequest(newExtendedAttribute, remoteFileName, null,null, null);
	ExtendedAttributeItemResponse result1 = TestInitializer.tasksApi.putExtendedAttribute(request1);
	assertNotNull(result1);
	assertEquals(200, (int) result1.getCode());
	assertNotNull(result1.getExtendedAttribute());
	assertEquals(newExtendedAttribute.getFieldName(), result1.getExtendedAttribute().getFieldName());
	assertEquals(newExtendedAttribute.getAlias(), result1.getExtendedAttribute().getAlias());
	assertEquals("188743737", result1.getExtendedAttribute().getFieldId());

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

Delete A Project Extended Attribute