Create issues
post
/fscmRestApi/resources/11.13.18.05/projectIssues
Request
Header Parameters
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
ClosedDate: string
(date)
Date when the issue is closed.
-
ClosedReason: string
Maximum Length:
80
Reason for closing an issue such as Resolved or Obsolete. -
ClosedReasonCode: string
Maximum Length:
30
Code representing the reason for closing a project issue, for example CANCELED, DUPLICATE, OBSOLETE, or RESOLVED. -
DateCreated(required): string
(date)
Date of creation of the issue.
-
IssueAction: array
Project Issue Action Items
Title:
Project Issue Action Items
The 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:
Email
Maximum Length:240
Email of the creator of the issue. -
IssueCreatorId(required): integer
(int64)
Identifier of the creator for an issue.
-
IssueDescription: string
Maximum Length:
1000
Detailed description of the project issue. -
IssueNumber(required): string
Maximum Length:
30
Displays the issue number. -
IssueOwnerEmail: string
Title:
Email
Maximum Length:240
Email of the owner of an issue. -
IssueOwnerId(required): integer
(int64)
A generated numeric ID for the person who owns the issue.
-
IssuePriority: string
Maximum Length:
80
The priority of the issue such as HIGH, MEDIUM, or LOW. -
IssueStatus: string
Maximum Length:
80
The status of the issue such as NEW, WORKING, or CLOSED. -
IssueType(required): string
Maximum Length:
30
Label to display the issue type. -
IssueTypeId(required): integer
(int64)
Identifier of the project issue the item is created for.
-
IssueUISummary(required): string
Maximum Length:
150
Summarized description of the issue. -
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:
30
The identifier of the type of object to which the issue is assigned, such as Program. -
PriorityCode: string
Maximum Length:
30
Code representing the priority of the project issue, for example, HIGH, MEDIUM, or LOW. -
ProjectId: integer
(int64)
Unique identifier of the project.
-
ProjectNumber: string
Title:
Project Number
Maximum Length:25
Unique identifier of the project associated to the issue. -
ReopenSummary: string
Maximum Length:
1000
Text describing the reason to reopen the issue. -
Resolution: string
Maximum Length:
1000
Text to provide the resolution summary when closing an issue. -
StatusCode(required): string
Maximum Length:
30
Code representing status of the project issue action item, for example, NOT STARTED, IN PROGRESS, or COMPLETE. -
TaskId: integer
(int64)
Id of the task for which issue is created.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Project Issue Action Items
Type:
array
Title:
Project Issue Action Items
The 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 : projectIssues-Attachments-item-post-request
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment.
Nested Schema : schema
Type:
Show Source
object
-
ActionItemOwnerEmail: string
Title:
Email
Maximum Length:240
Email 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.
-
ActionItemStatus: string
Maximum Length:
80
Status 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.
-
NeedByDate: string
(date)
The date by which the action item should be resolved or closed.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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-item-response
Type:
Show Source
object
-
Attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
ClosedDate: string
(date)
Date when the issue is closed.
-
ClosedReason: string
Maximum Length:
80
Reason for closing an issue such as Resolved or Obsolete. -
ClosedReasonCode: string
Maximum Length:
30
Code 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 Items
The 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:
Email
Maximum Length:240
Email of the creator of the issue. -
IssueCreatorId: integer
(int64)
Identifier of the creator for an issue.
-
IssueCreatorName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the creator of the issue. -
IssueDescription: string
Maximum Length:
1000
Detailed description of the project issue. -
IssueId: integer
(int64)
Read Only:
true
Automatically generated numeric ID for the issue. -
IssueNumber: string
Maximum Length:
30
Displays the issue number. -
IssueOwnerEmail: string
Title:
Email
Maximum Length:240
Email of the owner of an issue. -
IssueOwnerId: integer
(int64)
A generated numeric ID for the person who owns the issue.
-
IssueOwnerName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the owner of an issue. -
IssuePriority: string
Maximum Length:
80
The priority of the issue such as HIGH, MEDIUM, or LOW. -
IssueStatus: string
Maximum Length:
80
The status of the issue such as NEW, WORKING, or CLOSED. -
IssueType: string
Maximum Length:
30
Label to display the issue type. -
IssueTypeId: integer
(int64)
Identifier of the project issue the item is created for.
-
IssueUISummary: string
Maximum Length:
150
Summarized description of the issue. -
IssueUpdatedByName: string
Read Only:
true
Maximum Length:64
Name of owner that updated issue. -
links: array
Links
Title:
Links
The 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:
30
The identifier of the type of object to which the issue is assigned, such as Program. -
PriorityCode: string
Maximum Length:
30
Code 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 Name
Read Only:true
Maximum Length:240
Name of the project created for the issue. Name of the project associated with the project issue. -
ProjectNumber: string
Title:
Project Number
Maximum Length:25
Unique identifier of the project associated to the issue. -
ReopenSummary: string
Maximum Length:
1000
Text describing the reason to reopen the issue. -
Resolution: string
Maximum Length:
1000
Text to provide the resolution summary when closing an issue. -
StatusCode: string
Maximum Length:
30
Code representing status of the project issue action item, for example, NOT STARTED, IN PROGRESS, or COMPLETE. -
Task: string
Read Only:
true
Maximum Length:255
Name 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:
true
Date of issues when updated.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Project Issue Action Items
Type:
array
Title:
Project Issue Action Items
The 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:
array
Title:
Links
The 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 Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed 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:
true
Unique identifier of the action item associated to the issue. -
ActionItemOwnerEmail: string
Title:
Email
Maximum Length:240
Email 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:
Name
Read Only:true
Maximum Length:240
The person assigned to the action item. -
ActionItemStatus: string
Maximum Length:
80
Status 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:
Links
The 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:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- Attachments
-
Parameters:
- IssueId:
$request.path.IssueId
The attachments resource is used to view, create, and update attachments. - IssueId:
- IssueAction
-
Parameters:
- IssueId:
$request.path.IssueId
The Project Issues Action Items resource is used to view action items. Action items are tasks that are defined for issues that facilitates issue resolution. - IssueId: