Get all issues
get
/fscmRestApi/resources/11.13.18.05/projectIssues
Request
Query Parameters
- expand: string When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
- fields: string This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 - finder: string Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds all issues with the specificed issue ID.
Finder Variables:- IssueId; integer; Automatically generated numeric ID for the issue.
- PrimaryKey: Finds all issues with the specificed issue ID.
- limit: integer This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
- links: string This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical - offset: integer Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
- onlyData: boolean The resource item payload will be filtered in order to contain only data (no links section, for example).
- orderBy: string This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
- q: string This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ClosedDate; string; Date when the issue is closed.
- ClosedReason; string; Reason for closing an issue such as Resolved or Obsolete.
- ClosedReasonCode; string; Code representing the reason for closing a project issue, for example CANCELED, DUPLICATE, OBSOLETE, or RESOLVED.
- DateCreated; string; Date of creation of the issue.
- IssueCreatorEmail; string; Email of the creator of the issue.
- IssueCreatorId; integer; Identifier of the creator for an issue.
- IssueCreatorName; string; Name of the creator of the issue.
- IssueDescription; string; Detailed description of the project issue.
- IssueId; integer; Automatically generated numeric ID for the issue.
- IssueNumber; string; Displays the issue number.
- IssueOwnerEmail; string; Email of the owner of an issue.
- IssueOwnerId; integer; A generated numeric ID for the person who owns the issue.
- IssueOwnerName; string; Name of the owner of an issue.
- IssuePriority; string; The priority of the issue such as HIGH, MEDIUM, or LOW.
- IssueStatus; string; The status of the issue such as NEW, WORKING, or CLOSED.
- IssueType; string; Label to display the issue type.
- IssueTypeId; integer; Identifier of the project issue the item is created for.
- IssueUISummary; string; Summarized description of the issue.
- IssueUpdatedByName; string; Name of owner that updated issue.
- NeedByDate; string; The date by which the action item should be resolved or closed.
- ObjectId; integer; The identifier of the object to which an issue is assigned.
- ObjectType; string; The identifier of the type of object to which the issue is assigned, such as Program.
- PriorityCode; string; Code representing the priority of the project issue, for example, HIGH, MEDIUM, or LOW.
- ProjectId; integer; Unique identifier of the project.
- ProjectName; string; Name of the project created for the issue. Name of the project associated with the project issue.
- ProjectNumber; string; Unique identifier of the project associated to the issue.
- ReopenSummary; string; Text describing the reason to reopen the issue.
- Resolution; string; Text to provide the resolution summary when closing an issue.
- StatusCode; string; Code representing status of the project issue action item, for example, NOT STARTED, IN PROGRESS, or COMPLETE.
- Task; string; Name of the task for which issue is created.
- TaskId; integer; Id of the task for which issue is created.
- UpdateDate; string; Date of issues when updated.
- totalResults: boolean The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
- Metadata-Context: string If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version: string The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
- Metadata-Context: If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version: The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : projectIssues
Type:
Show Source object- count(required): integer The number of resource instances returned in the current range.
- hasMore(required): boolean Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
- items: array Items Title:
ItemsThe items in the collection. - limit(required): integer The actual paging size used by the server.
- links(required): array Links Title:
LinksThe link relations associated with the resource instance. - offset(required): integer The offset value used in the current page.
- totalResults: integer The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source Nested Schema : projectIssues-item-response
Type:
Show Source object- Attachments: array Attachments Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. - ClosedDate: string (date) Date when the issue is closed.
- ClosedReason: string Maximum Length:
80Reason for closing an issue such as Resolved or Obsolete. - ClosedReasonCode: string Maximum Length:
30Code representing the reason for closing a project issue, for example CANCELED, DUPLICATE, OBSOLETE, or RESOLVED. - DateCreated: string (date) Date of creation of the issue.
- IssueAction: array Project Issue Action Items Title:
Project Issue Action ItemsThe Project Issues Action Items resource is used to view action items. Action items are tasks that are defined for issues that facilitates issue resolution. - IssueCreatorEmail: string Title:
EmailMaximum Length:240Email of the creator of the issue. - IssueCreatorId: integer (int64) Identifier of the creator for an issue.
- IssueCreatorName: string Title:
NameRead Only:trueMaximum Length:240Name of the creator of the issue. - IssueDescription: string Maximum Length:
1000Detailed description of the project issue. - IssueId: integer (int64) Read Only:
trueAutomatically generated numeric ID for the issue. - IssueNumber: string Maximum Length:
30Displays the issue number. - IssueOwnerEmail: string Title:
EmailMaximum Length:240Email of the owner of an issue. - IssueOwnerId: integer (int64) A generated numeric ID for the person who owns the issue.
- IssueOwnerName: string Title:
NameRead Only:trueMaximum Length:240Name of the owner of an issue. - IssuePriority: string Maximum Length:
80The priority of the issue such as HIGH, MEDIUM, or LOW. - IssueStatus: string Maximum Length:
80The status of the issue such as NEW, WORKING, or CLOSED. - IssueType: string Maximum Length:
30Label to display the issue type. - IssueTypeId: integer (int64) Identifier of the project issue the item is created for.
- IssueUISummary: string Maximum Length:
150Summarized description of the issue. - IssueUpdatedByName: string Read Only:
trueMaximum Length:64Name of owner that updated issue. - links: array Links Title:
LinksThe link relations associated with the resource instance. - NeedByDate: string (date) The date by which the action item should be resolved or closed.
- ObjectId: integer (int64) The identifier of the object to which an issue is assigned.
- ObjectType: string Maximum Length:
30The identifier of the type of object to which the issue is assigned, such as Program. - PriorityCode: string Maximum Length:
30Code representing the priority of the project issue, for example, HIGH, MEDIUM, or LOW. - ProjectId: integer (int64) Unique identifier of the project.
- ProjectName: string Title:
Project NameRead Only:trueMaximum Length:240Name of the project created for the issue. Name of the project associated with the project issue. - ProjectNumber: string Title:
Project NumberMaximum Length:25Unique identifier of the project associated to the issue. - ReopenSummary: string Maximum Length:
1000Text describing the reason to reopen the issue. - Resolution: string Maximum Length:
1000Text to provide the resolution summary when closing an issue. - StatusCode: string Maximum Length:
30Code representing status of the project issue action item, for example, NOT STARTED, IN PROGRESS, or COMPLETE. - Task: string Read Only:
trueMaximum Length:255Name of the task for which issue is created. - TaskId: integer (int64) Id of the task for which issue is created.
- UpdateDate: string (date-time) Read Only:
trueDate of issues when updated.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source Nested Schema : Project Issue Action Items
Type:
arrayTitle:
Project Issue Action ItemsThe Project Issues Action Items resource is used to view action items. Action items are tasks that are defined for issues that facilitates issue resolution.
Show Source Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source Nested Schema : projectIssues-Attachments-item-response
Type:
Show Source object- AsyncTrackerId: string Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. - AttachedDocumentId: integer (int64) Title:
Attached Document IdThe unique identifier of the attached document. - CategoryName: string Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
- CreatedBy: string Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. - CreatedByUserName: string Title:
Created By User NameRead Only:trueThe user name who created the record. - CreationDate: string (date-time) Title:
Creation DateRead Only:trueThe date when the record was created. - DatatypeCode: string Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. - Description: string Title:
DescriptionMaximum Length:255The description of the attachment. - DmDocumentId: string Maximum Length:
255The document ID from which the attachment is created. - DmFolderPath: string Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. - DmVersionNumber: string Maximum Length:
255The document version number from which the attachment is created. - DownloadInfo: string Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. - ErrorStatusCode: string Title:
Error Status CodeThe error code, if any, for the attachment. - ErrorStatusMessage: string Title:
Error Status MessageThe error message, if any, for the attachment. - ExpirationDate: string (date-time) Title:
Expiration DateThe expiration date of the contents in the attachment. - FileContents: string (byte) Title:
File ContentsThe contents of the attachment. - FileName: string Title:
File NameMaximum Length:2048The file name of the attachment. - FileUrl: string Title:
File UrlThe URI of the file. - FileWebImage: string (byte) Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. - LastUpdateDate: string (date-time) Title:
Last Update DateRead Only:trueThe date when the record was last updated. - LastUpdatedBy: string Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. - LastUpdatedByUserName: string Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. - links: array Links Title:
LinksThe link relations associated with the resource instance. - PostProcessingAction: string Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. - Title: string Title:
TitleThe title of the attachment. - UploadedFileContentType: string Title:
Uploaded File Content TypeThe content type of the attachment. - UploadedFileLength: integer Title:
File SizeThe size of the attachment file. - UploadedFileName: string Title:
Uploaded File NameThe name to assign to a new attachment file. - UploadedText: string Title:
Uploaded TextThe text content for a new text attachment. - Uri: string Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. - Url: string Title:
UrlMaximum Length:4000The URL of a web page type attachment. - UserName: string Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source Nested Schema : link
Type:
Show Source object- href: string Title:
hyperlink referenceThe URI to the related resource. - kind: string Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. - name: string Title:
nameThe name of the link to the related resource. - properties: object properties
- rel: string Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source object- changeIndicator: string Change indicator or the ETag value of the resource instance.
Nested Schema : projectIssues-IssueAction-item-response
Type:
Show Source object- ActionItemId: integer (int64) Read Only:
trueUnique identifier of the action item associated to the issue. - ActionItemOwnerEmail: string Title:
EmailMaximum Length:240Email address of the person who owns the action item associated to the project issue. - ActionItemOwnerId: integer The status of the action item, for example, NEW, WORKING, or CLOSED.
- ActionItemOwnerName: string Title:
NameRead Only:trueMaximum Length:240The person assigned to the action item. - ActionItemStatus: string Maximum Length:
80Status of the project issue action item, for example, NOT STARTED, IN PROGRESS, or COMPLETE. - ActionItemStatusCode: string The status of the action item such as NEW, WORKING, or CLOSED.
- ActionItemSummary: string The short text describing the action item associated to the issue.
- Description: string The long text describing the action item associated to the issue.
- links: array Links Title:
LinksThe link relations associated with the resource instance. - NeedByDate: string (date) The date by which the action item should be resolved or closed.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source Examples
The following example shows how to get all issues by submitting a GET request on the REST resource using cURL.
curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectIssues
Response Body Example
The following shows an example of the response body in JSON format.
{ "items": [ { "IssueId": 300100023181086, "IssueUISummary": "CDRM Issue Created to Test Search from Manage Issues page", "IssueNumber": "1", "IssueOwnerId": 300100023180799, "ProjectId": null, "PriorityCode": "MEDIUM", "StatusCode": "NEW", "IssueTypeId": 1, "IssueDescription": null, "NeedByDate": null, "DateCreated": "2013-08-13", "ClosedDate": null, "ClosedReasonCode": null, "Resolution": null, "ReopenSummary": null, "IssueCreatorId": 300100023180799, "IssueUpdatedByName": "George.White", "UpdateDate": "2014-01-07T05:08:58+00:00", "IssueOwnerEmail": "prj_george_white_in_grp@oracle.com", "IssueOwnerName": "George White", "ProjectName": null, "ProjectNumber": null, "IssuePriority": "Medium", "IssueStatus": "New", "IssueCreatorEmail": "prj_george_white_in_grp@oracle.com", "IssueCreatorName": "George White", "ClosedReason": null, "IssueType": "General" }