Get List of Projects Online

Introduction

This example explains how to get online projects list by providing Token or Login and Password credentials 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/projectOnline/projectList	GET	Gets the list of published projects in the current Project Online account	GetProjectList

cURL Example

Request


curl -X GET "https://api.aspose.cloud/v3.0/tasks/projectOnline/projectList?siteUrl=http%3A%2F%2Fproject_server_instance.local%2Fsites%2Fpwa&userName=SomeLogin" -H "accept: application/json" -H "x-sharepoint-password: SomePassword" -H "x-aspose-client: Containerize.Swagger"

Response


{

  "code": 0,
  "status": "string",
  "projects": {
    "link": {
      "href": "string",
      "rel": "string",
      "type": "string",
      "title": "string"
    },
    "projectInfo": [
      {
        "id": "string",
        "name": "string",
        "createdDate": "2020-06-27T16:22:17.414Z",
        "isCheckedOut": true,
        "lastPublishedDate": "2020-06-27T16:22:17.414Z",
        "lastSavedDate": "2020-06-27T16:22:17.414Z",
        "description": "string"
      }
    ]
  }
}

Case 2: Get list of projects online using token credentials

Request


curl -X GET "https://api.aspose.cloud/v3.0/tasks/projectOnline/projectList?siteUrl=http%3A%2F%2Fproject_server_instance.local%2Fsites%2Fpwa" -H "accept: application/json" -H "x-project-online-token: SOMESECRETTOKEN" -H "x-aspose-client: Containerize.Swagger"

Response


{
  "code": 0,
  "status": "string",
  "projects": {
    "link": {
      "href": "string",
      "rel": "string",
      "type": "string",
      "title": "string"
    },
    "projectInfo": [
      {
        "id": "string",
        "name": "string",
        "createdDate": "2020-06-27T16:22:17.414Z",
        "isCheckedOut": true,
        "lastPublishedDate": "2020-06-27T16:22:17.414Z",
        "lastSavedDate": "2020-06-27T16:22:17.414Z",
        "description": "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 response = await TasksApi.GetProjectListAsync(new GetProjectListRequest
	{
	UserName = "SomeLogin",
	XSharepointPassword = "SomePassword",
	SiteUrl = "http://project_server_instance.local/sites/pwa"
	});

	Assert.AreEqual((int)HttpStatusCode.OK, response.Code);
	Assert.That(response.Projects, Is.Not.Empty);

view raw Examples-GetProjectListByLoginPassword.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/
	static::markTestSkipped('Ignored because real credentials for project server online is required');

	$response = $this->tasks->getProjectList(new GetProjectListRequest
	('http://project_server_instance.local/sites/pwa', null, 'SomeLogin', 'SomePassword'));

	Assert::assertEquals(200, $response->getCode());
	Assert::assertNotEmpty($response->getProjects());

view raw Example-GetProjectListByLoginAndPassword.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
	get_request = GetProjectListRequest('http://project_server_instance.local/sites/pwa')
	get_request.user_name = 'SomeUserName'
	get_request.x_sharepoint_password = 'SomePassword'
	get_result = self.tasks_api.get_project_list(get_request)
	self.assertIsNotNone(get_result)
	self.assertIsInstance(get_result, ProjectListResponse)
	self.assertLessEqual(1, len(get_result.projects.project_info))

view raw get_project_list_by_login_password.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 request = new GetProjectListRequest();
	request.userName = "SomeLogin";
	request.xSharepointPassword = "SomePassword";
	request.siteUrl = "http://project_server_instance.local/sites/pwa";

	const result = await tasksApi.getProjectList(request);

	expect(result.response.statusCode).to.equal(200);
	expect(result.body.projects).not.null.and.not.undefined;
	expect(result.body.projects.projectInfo.length).to.be.at.least(1);

view raw GetProjectListByLoginAndPassword.js 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 := PrepareTest(t, config)

	getOptions := &requests.GetProjectListOpts{
	SiteUrl: "http://project_server_instance.local/sites/pwa",
	UserName: optional.NewString("SomeLogin"),
	XSharepointPassword: optional.NewString("SomePassword"),
	}
	result, _, err := client.TasksApi.GetProjectList(ctx, getOptions)
	if err != nil {
	t.Error(err)
	}
	assert.Equal(t, int32(200), result.Code)
	assert.NotNil(t, result.Projects)
	assert.LessOrEqual(t, 1, len(result.Projects.ProjectInfo))

view raw Examples-GetProjectListByLoginPassword.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/
	GetProjectListRequest request = new GetProjectListRequest("http://project_server_instance.local/sites/pwa", "SomeLogin", null, "SomePassword");
	ProjectListResponse result = TestInitializer.tasksApi.getProjectList(request);
	assertNotNull(result);
	assertEquals(200, result.getCode().intValue());
	assertNotNull(result.getProjects());
	assertTrue(0 < result.getProjects().getProjectInfo().size());

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

Case 2: Import project online using token credentials

	// For complete examples and data files, please go to https://github.com/aspose-tasks-cloud/aspose-tasks-cloud-dotnet/
	var response = await TasksApi.GetProjectListAsync(new GetProjectListRequest
	{
	Token = "SOMESECRETTOKEN",
	SiteUrl = "http://project_server_instance.local/sites/pwa"
	});

	Assert.AreEqual((int)HttpStatusCode.OK, response.Code);
	Assert.That(response.Projects, Is.Not.Empty);

view raw Examples-GetProjectListByToken.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/
	static::markTestSkipped('Ignored because real credentials for project server online is required');

	$response = $this->tasks->getProjectList(new GetProjectListRequest
	('http://project_server_instance.local/sites/pwa', 'SOMESECRETTOKEN'));

	Assert::assertEquals(200, $response->getCode());
	Assert::assertNotEmpty($response->getProjects());

view raw Example-GetProjectListByTokenCredential.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
	get_request = GetProjectListRequest('http://project_server_instance.local/sites/pwa')
	get_request.x_project_online_token = 'SOMESECRETTOKEN'
	get_result = self.tasks_api.get_project_list(get_request)
	self.assertIsNotNone(get_result)
	self.assertIsInstance(get_result, ProjectListResponse)
	self.assertLessEqual(1, len(get_result.projects.project_info))

view raw get_project_list_by_token.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 request = new GetProjectListRequest();
	request.xProjectOnlineToken = "SOMESECRETTOKEN";
	request.siteUrl = "http://project_server_instance.local/sites/pwa";

	const result = await tasksApi.getProjectList(request);

	expect(result.response.statusCode).to.equal(200);
	expect(result.body.projects).not.null.and.not.undefined;
	expect(result.body.projects.projectInfo.length).to.be.at.least(1);

view raw GetProjectListByToken.js 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 := PrepareTest(t, config)

	getOptions := &requests.GetProjectListOpts{
	SiteUrl: "http://project_server_instance.local/sites/pwa",
	XProjectOnlineToken: optional.NewString("SOMESECRETTOKEN"),
	}
	result, _, err := client.TasksApi.GetProjectList(ctx, getOptions)
	if err != nil {
	t.Error(err)
	}
	assert.Equal(t, int32(200), result.Code)
	assert.NotNil(t, result.Projects)
	assert.LessOrEqual(t, 1, len(result.Projects.ProjectInfo))

view raw Examples-GetProjectListByToken.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/
	GetProjectListRequest request = new GetProjectListRequest("http://project_server_instance.local/sites/pwa", null, "SOMESECRETTOKEN", null);
	ProjectListResponse result = TestInitializer.tasksApi.getProjectList(request);
	assertNotNull(result);
	assertEquals(200, result.getCode().intValue());
	assertNotNull(result.getProjects());
	assertTrue(0 < result.getProjects().getProjectInfo().size());

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

Import from Project Online Create New Project Online