Name | Type | Required | Description |
|---|---|---|---|
$count | Boolean | Optional | Controls whether the total count of matching projects is included in the response as @odata.count. Allowed values are true and false. |
$expand | String | Optional | Comma-separated list of related resources to embed inline within each project resource in the response. Allowed values are userInfo. |
$top | Integer | Optional | Maximum number of projects to return per page. Use this parameter with $skip to paginate through the full result set. |
$skip | Integer | Optional | Number of resources to skip before returning results. Set to 0 to start from the first resource. |
$orderby | String | Optional | Field used to sort the returned project list. Accepts a field name followed by asc or desc to control sort direction. For example, lastUpdatedTime desc. |
Name | Required or Optional | Description |
|---|---|---|
IDS-SESSION-ID | Required | Session token used to authenticate the request. |
Name | Type | Description |
|---|---|---|
@odata.context | String | OData context string that identifies the metadata type and expanded navigation properties included in the response. |
@odata.count | Integer | Total number of projects available across all pages, regardless of the current page size or offset. |
value | Array | Array of project resources returned for the current page, ordered by lastUpdatedTime descending. |
value.id | String | Unique identifier for the project. |
value.name | String | Display name of the project. |
value.description | String | Text description of the project. |
value.owner | String | User ID of the project owner. |
value.createdBy | String | ID of the user who created the project. |
value.lastUpdatedBy | String | ID of the user who last modified the project. |
value.lastAccessedBy | String | ID of the user who most recently accessed the project. |
value.createdTime | String | ISO 8601 timestamp indicating when the project was created, in UTC format. |
value.lastUpdatedTime | String | ISO 8601 timestamp indicating when the project was last modified, in UTC format. |
value.lastAccessedTime | String | ISO 8601 timestamp indicating when the project was last accessed. |
value.expiresBy | String | ISO 8601 timestamp indicating when the project expires, after which the project may no longer be accessible. |
value.parentInfo | Array | Array of objects identifying the parent container of the project, including the parent's ID, name, and type (such as Space). |
value.documentType | String | Type of document resource. |
value.contentType | String | Storage format of the project's content. |
value.documentState | String | Processing state of the project document, indicating whether the project content is fully available. |
value.aclRule | String | Access control rule applied to the project, determining the sharing scope. |
value.subcontainerCount | Integer | Number of direct subcontainers within the project. |
value.customAttributes | Object | Container object holding custom metadata attributes assigned to the project, grouped into string, number, and date attribute arrays. |
value.repoInfo | Array | Array of objects identifying the repositories. |
value.isSourceControlled | Boolean | Indicates whether the project is under source control. |
value.checkedOutById | String | ID of the user who has currently checked out the project. |