Create one affected item attachment
post
/fscmRestApi/resources/11.13.18.05/newItemRequests/{NewItemRequestId}/child/newItemRequestAffectedItems/{newItemRequestAffectedItemsUniqID}/child/attachments
Request
Path Parameters
-
NewItemRequestId(required): integer
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
newItemRequestAffectedItemsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the New Item Request Lines resource and used to uniquely identify an instance of New Item Request Lines. The client should not generate the hash key value. Instead, the client should query on the New Item Request Lines collection resource in order to navigate to a specific instance of New Item Request Lines 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-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAsynchronous tracker ID value for the affected item attachment on a new item request. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdAttached document ID for the affected item attachment on a new item request. -
CategoryName: string
Title:
CategoryMaximum Length:30Category name for the affected item attachment on a new item request. -
ContentRepositoryFileCheckedOutBy: string
Title:
Checked Out ByThe user who has checked out the new item request affected items attachment from the repository. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEData type code for the affected item attachment on a new item request. -
DataTypeName: string
Type of data for the affected item attachment on a new item request.
-
Description: string
Title:
DescriptionMaximum Length:255Description of the affected item attachment on a new item request. -
DmDocumentId: string
Maximum Length:
255DM (Document Management) document ID for the affected item attachment on a new item request. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000DM folder path for the affected item attachment on a new item request. -
DmVersionNumber: string
Maximum Length:
255DM version number for the affected item attachment on a new item request. -
DownloadInfo: string
Title:
DownloadInfoDownload info for the affected item attachment on a new item request. -
ErrorStatusCode: string
Title:
Error Status CodeError status code for the affected item attachment on a new item request. -
ErrorStatusMessage: string
Title:
Error Status MessageError status message for the affected item attachment on a new item request. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration data for the affected item attachment on a new item request. -
FileContents: string
(byte)
Title:
File ContentsFile contents of the affected item attachment on a new item request. -
FileName: string
Title:
File NameMaximum Length:2048File name of the affected item attachment on a new item request. -
FileUrl: string
Title:
File UrlFile URL of the affected item attachment on a new item request. -
PostProcessingAction: string
Title:
PostProcessingActionPostprocessing action for the affected item attachment on a new item request. -
Title: string
Title:
TitleTitle of the affected item attachment on a new item request. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeUploaded file content type for the affected item attachment on a new item request. -
UploadedFileLength: integer
Title:
File SizeUploaded file length for the affected item attachment on a new item request. -
UploadedFileName: string
Title:
Uploaded File NameUploaded file name for the affected item attachment on a new item request. -
UploadedText: string
Title:
Uploaded TextUploaded text for the affected item attachment on a new item request. -
Uri: string
Title:
UriMaximum Length:4000URI for the affected item attachment on a new item request. -
Url: string
Title:
UrlMaximum Length:4000URL for the affected item attachment on a new item request.
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 : newItemRequests-newItemRequestAffectedItems-attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAsynchronous tracker ID value for the affected item attachment on a new item request. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdAttached document ID for the affected item attachment on a new item request. -
CategoryName: string
Title:
CategoryMaximum Length:30Category name for the affected item attachment on a new item request. -
ContentRepositoryFileCheckedOutBy: string
Title:
Checked Out ByThe user who has checked out the new item request affected items attachment from the repository. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255User who created the affected item attachment on a new item request. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueName of the user who created the affected item attachment on a new item request. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueCreation date of the affected item attachment on a new item request. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEData type code for the affected item attachment on a new item request. -
DataTypeName: string
Type of data for the affected item attachment on a new item request.
-
Description: string
Title:
DescriptionMaximum Length:255Description of the affected item attachment on a new item request. -
DmDocumentId: string
Maximum Length:
255DM (Document Management) document ID for the affected item attachment on a new item request. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000DM folder path for the affected item attachment on a new item request. -
DmVersionNumber: string
Maximum Length:
255DM version number for the affected item attachment on a new item request. -
DocumentPreviewURL: string
Read Only:
trueMaximum Length:255Document preview value for the affected item attachment on a new item request. -
DownloadInfo: string
Title:
DownloadInfoDownload info for the affected item attachment on a new item request. -
ErrorStatusCode: string
Title:
Error Status CodeError status code for the affected item attachment on a new item request. -
ErrorStatusMessage: string
Title:
Error Status MessageError status message for the affected item attachment on a new item request. -
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration data for the affected item attachment on a new item request. -
FileContents: string
(byte)
Title:
File ContentsFile contents of the affected item attachment on a new item request. -
FileName: string
Title:
File NameMaximum Length:2048File name of the affected item attachment on a new item request. -
FileUrl: string
Title:
File UrlFile URL of the affected item attachment on a new item request. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueFile web image for the affected item attachment on a new item request. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueLast update date of the affected item attachment on a new item request. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255User who last updated the affected item attachment on a new item request. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueName of the user who last updated the affected item attachment on a new item request. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionPostprocessing action for the affected item attachment on a new item request. -
Title: string
Title:
TitleTitle of the affected item attachment on a new item request. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeUploaded file content type for the affected item attachment on a new item request. -
UploadedFileLength: integer
Title:
File SizeUploaded file length for the affected item attachment on a new item request. -
UploadedFileName: string
Title:
Uploaded File NameUploaded file name for the affected item attachment on a new item request. -
UploadedText: string
Title:
Uploaded TextUploaded text for the affected item attachment on a new item request. -
Uri: string
Title:
UriMaximum Length:4000URI for the affected item attachment on a new item request. -
Url: string
Title:
UrlMaximum Length:4000URL for the affected item attachment on a new item request. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255Name for the affected item attachment on a new item request.
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:
- NewItemRequestId:
$request.path.NewItemRequestId - attachmentsUniqID2:
$request.path.attachmentsUniqID2 - newItemRequestAffectedItemsUniqID:
$request.path.newItemRequestAffectedItemsUniqID
Action to cancel the check out of the new item request's affected items attachment, so it stays checked in. - NewItemRequestId:
- checkIn
-
Parameters:
- NewItemRequestId:
$request.path.NewItemRequestId - attachmentsUniqID2:
$request.path.attachmentsUniqID2 - newItemRequestAffectedItemsUniqID:
$request.path.newItemRequestAffectedItemsUniqID
Action to check in the new item request's affected item's attachments, after updating. - NewItemRequestId:
- checkOut
-
Parameters:
- NewItemRequestId:
$request.path.NewItemRequestId - attachmentsUniqID2:
$request.path.attachmentsUniqID2 - newItemRequestAffectedItemsUniqID:
$request.path.newItemRequestAffectedItemsUniqID
Action to check out the new item request's affected item's attachment to make updates - NewItemRequestId:
- fetchVersions
-
Parameters:
- NewItemRequestId:
$request.path.NewItemRequestId - attachmentsUniqID2:
$request.path.attachmentsUniqID2 - newItemRequestAffectedItemsUniqID:
$request.path.newItemRequestAffectedItemsUniqID
- NewItemRequestId:
- updateActiveVersion
-
Parameters:
- NewItemRequestId:
$request.path.NewItemRequestId - attachmentsUniqID2:
$request.path.attachmentsUniqID2 - newItemRequestAffectedItemsUniqID:
$request.path.newItemRequestAffectedItemsUniqID
- NewItemRequestId: