GET v1/{subscriptionID}/projects?types[0]={types[0]}&types[1]={types[1]}&statuses[0]={statuses[0]}&statuses[1]={statuses[1]}&automationModes[0]={automationModes[0]}&automationModes[1]={automationModes[1]}&bindingTypes[0]={bindingTypes[0]}&bindingTypes[1]={bindingTypes[1]}&page={page}&pageSize={pageSize}&sortBy={sortBy}&sortOrder={sortOrder}&familyID={familyID}&modifierID={modifierID}&search={search}

Gets all projects for a user in a subscription.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subscriptionID

The Circle subscription ID.

globally unique identifier

Required

types

The Circle project types to be filtered.

Collection of ProjectType

Optional

statuses

The Circle project statuses to be filtered.

Collection of ProjectStatus

Optional

automationModes

The Circle project automation modes to be filtered.

Collection of ProjectAutomationMode

Optional

bindingTypes

The Circle project binding types to be filtered.

Collection of ProjectBindingType

Optional

page

The page to display.

integer

Optional. Default value is 1

pageSize

The number of records to display on the page.

integer

Optional. Default value is 50

sortBy

The column to sort by.

SortByType

Optional. Default value is Default

sortOrder

The sort by order.

SortOrderType

Optional. Default value is Ascending

familyID

The family ID of the Circle projects to be filtered.

globally unique identifier

Optional

modifierID

The user ID of a user who modified the projects to be filtered.

globally unique identifier

Optional

search

Text to search in the project name or friendly instance ID.

string

Optional

Body Parameters

None.

Response Information

Resource Description

Returns all projects for a user that is associated with the specified security token in the specified user subscription ID, after filters were applied.

Collection of ProjectViewModel
NameDescriptionTypeAdditional information
ID

Gets the project ID.

globally unique identifier

None.

Name

Gets and sets the project name.

string

None.

Modifier

Gets the user who was the last to modify the project.

UserViewModel

None.

ModificationTime

Gets the modification time of the project.

date

None.

AutomationMode

Gets the automation mode of the project.

ProjectAutomationMode

None.

Status

Gets the project status.

ProjectStatus

None.

BindingType

Gets the binding type of the project.

ProjectBindingType

None.

Type

Gets the project type.

ProjectType

None.

IsSample

Gets the value indicating whether this project is a sample project.

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "ID": "09f9ffde-da6e-4777-b5b1-0aa4ce1261e9",
    "Name": "sample string 2",
    "Modifier": {
      "ID": "39342c4d-cfd7-491e-9e25-af3ec725a352",
      "Name": "sample string 2"
    },
    "ModificationTime": "2021-12-02T21:25:29.8448686Z",
    "AutomationMode": 1,
    "Status": 1,
    "BindingType": 1,
    "Type": 1,
    "IsSample": true,
    "FriendlyID": "sample string 5",
    "FamilyID": "de0b921e-2b33-48c0-a67f-59ac4b276c6e"
  },
  {
    "ID": "09f9ffde-da6e-4777-b5b1-0aa4ce1261e9",
    "Name": "sample string 2",
    "Modifier": {
      "ID": "39342c4d-cfd7-491e-9e25-af3ec725a352",
      "Name": "sample string 2"
    },
    "ModificationTime": "2021-12-02T21:25:29.8448686Z",
    "AutomationMode": 1,
    "Status": 1,
    "BindingType": 1,
    "Type": 1,
    "IsSample": true,
    "FriendlyID": "sample string 5",
    "FamilyID": "de0b921e-2b33-48c0-a67f-59ac4b276c6e"
  }
]