Add multiple attachments to a problem report
post
/fscmRestApi/resources/11.13.18.05/qualityProblemReports/{qualityProblemReportsUniqID}/child/problemReportAttachments
Request
Path Parameters
-
qualityProblemReportsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Quality Problem Reports resource and used to uniquely identify an instance of Quality Problem Reports. The client should not generate the hash key value. Instead, the client should query on the Quality Problem Reports collection resource in order to navigate to a specific instance of Quality Problem Reports to get the hash key.
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.
-
Upsert-Mode: string
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-
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category name of a problem-report attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEUnique identifier of the datatype of the attachment. -
DataTypeName: string
Data type of the problem report attachment, such as file, text, URL, repository file, or repository folder.
-
Description: string
Title:
DescriptionMaximum Length:255Attribute value that represents the description of the attachment. -
DmDocumentId: string
Maximum Length:
255Unique identifier of the document in the repository. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Attribute value that represents the repository folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255Attribute value that represents the version number of the attachment in the repository. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError status code for the corrective-action attachment upload. -
ErrorStatusMessage: string
Title:
Error Status MessageError status message for the corrective-action attachment upload. -
ExpirationDate: string
(date-time)
Title:
Expiration DateAttachment expiration date of the corrective action. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048File name of the problem report attachment. -
FileUrl: string
Title:
File UrlFile URL of the problem report attachment. -
Title: string
Title:
TitleAttribute value that represents the title of a problem report attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the uploaded corrective-action attachment. -
UploadedFileLength: integer
Title:
File SizeFile length of the uploaded problem-report attachment. -
UploadedFileName: string
Title:
Uploaded File NameFile name of the uploaded problem-report attachment. -
UploadedText: string
Title:
Uploaded TextContents of the attached text file. -
Uri: string
Title:
UriMaximum Length:4000Attribute value that represents the URI for the attachment. -
Url: string
Title:
UrlMaximum Length:4000Attribute value that represents the URL for the attachment.
Response
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 : qualityProblemReports-problemReportAttachments-item-response
Type:
Show Source
object-
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30Category name of a problem-report attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the problem-report attachment. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueName of the user who created the problem-report attachment. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueDate when the change object was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEUnique identifier of the datatype of the attachment. -
DataTypeName: string
Data type of the problem report attachment, such as file, text, URL, repository file, or repository folder.
-
Description: string
Title:
DescriptionMaximum Length:255Attribute value that represents the description of the attachment. -
DmDocumentId: string
Maximum Length:
255Unique identifier of the document in the repository. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000Attribute value that represents the repository folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255Attribute value that represents the version number of the attachment in the repository. -
DocumentPreviewURL: string
Read Only:
trueMaximum Length:255URL that identifies the problem report document preview. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeError status code for the corrective-action attachment upload. -
ErrorStatusMessage: string
Title:
Error Status MessageError status message for the corrective-action attachment upload. -
ExpirationDate: string
(date-time)
Title:
Expiration DateAttachment expiration date of the corrective action. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048File name of the problem report attachment. -
FileUrl: string
Title:
File UrlFile URL of the problem report attachment. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueAttribute that indicates the date and time of the last update of the attachment. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who last updated the problem-report attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueName of the user who last updated the problem-report attachment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Title: string
Title:
TitleAttribute value that represents the title of a problem report attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeContent type of the uploaded corrective-action attachment. -
UploadedFileLength: integer
Title:
File SizeFile length of the uploaded problem-report attachment. -
UploadedFileName: string
Title:
Uploaded File NameFile name of the uploaded problem-report attachment. -
UploadedText: string
Title:
Uploaded TextContents of the attached text file. -
Uri: string
Title:
UriMaximum Length:4000Attribute value that represents the URI for the attachment. -
Url: string
Title:
UrlMaximum Length:4000Attribute value that represents the URL for the attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Attribute value that represents the name of user who uploaded 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.
Links
- cancelCheckOut
-
Parameters:
- problemReportAttachmentsUniqID:
$request.path.problemReportAttachmentsUniqID - qualityProblemReportsUniqID:
$request.path.qualityProblemReportsUniqID
Cancels the checkout and makes the problem report attachment available to other users. - problemReportAttachmentsUniqID:
- checkIn
-
Parameters:
- problemReportAttachmentsUniqID:
$request.path.problemReportAttachmentsUniqID - qualityProblemReportsUniqID:
$request.path.qualityProblemReportsUniqID
Marks the problem report attachment as temporarily unavailable to other users, until the item attachment is checked in or another user undoes the checkout. - problemReportAttachmentsUniqID:
- checkOut
-
Parameters:
- problemReportAttachmentsUniqID:
$request.path.problemReportAttachmentsUniqID - qualityProblemReportsUniqID:
$request.path.qualityProblemReportsUniqID
Checks out the problem report attachment and marks it as locked for other users. - problemReportAttachmentsUniqID:
Examples
This example describes how to add multiple attachments to a problem report.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/qualityProblemReports/qualityProblemReportsUniqID/child/problemReportAttachments"
Example Request Body
The following example includes the contents of the request body in JSON format:
{
"DatatypeCode" : "WEB_PAGE",
"Description" : "URL added from REST sample",
"Title" : "Link to sample.de",
"Url" : "https://www.sample.com"
}
Example Response Body
The following example includes the contents of the response body in JSON format:
{
"LastUpdateDate": "2021-11-19T00:16:08.725+00:00",
"LastUpdatedBy": "PLM_AUTO",
"DatatypeCode": "WEB_PAGE",
"FileName": null,
"DmFolderPath": "",
"DmDocumentId": null,
"DmVersionNumber": null,
"Url": "https://www.sample.com",
"CategoryName": "DOCUMENT",
"UserName": null,
"Uri": null,
"FileUrl": null,
"UploadedText": null,
"UploadedFileContentType": null,
"UploadedFileLength": null,
"UploadedFileName": null,
"ContentRepositoryFileShared": "false",
"Title": "Link to sample.de",
"Description": "URL added from REST sample",
"ErrorStatusCode": null,
"ErrorStatusMessage": null,
"CreatedBy": "PLM_AUTO",
"CreationDate": "2021-11-19T00:16:08+00:00",
"ExpirationDate": null,
"LastUpdatedByUserName": "AUTO PLM",
"CreatedByUserName": "AUTO PLM",
"AsyncTrackerId": null,
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/qualityProblemReports/300100549761903/child/problemReportAttachments/00020000000EACED00057708000110F09AAA5B850000000EACED00057708000110F09AAA5B84",
"name": "problemReportAttachments",
"kind": "item"
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/qualityProblemReports/300100549761903/child/problemReportAttachments/00020000000EACED00057708000110F09AAA5B850000000EACED00057708000110F09AAA5B84",
"name": "problemReportAttachments",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername/fscmRestApi/resources/version/qualityProblemReports/300100549761903",
"name": "qualityProblemReports",
"kind": "item"
},
{
"rel": "enclosure",
"href": "https://servername/fscmRestApi/resources/version/qualityProblemReports/300100549761903/child/problemReportAttachments/00020000000EACED00057708000110F09AAA5B850000000EACED00057708000110F09AAA5B84/enclosure/FileWebImage",
"name": "FileWebImage",
"kind": "other"
}
]
}