Create receipt header attachments

post

/fscmRestApi/resources/11.13.18.05/receivingReceiptRequests/{HeaderInterfaceId}/child/attachments

Request

Path Parameters
Header Parameters
  • 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".
  • 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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Asynchronous Upload Tracker Id
    Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
  • Title: Attached Document Id
    Value that uniquely identifies the attachment of a shipment line. It is a primary key that the application generates when a document is attached to the advanced shipment notice (ASN) line request.
  • Title: Category
    Maximum Length: 30
    Category of the attachment for the advanced shipment notice (ASN) line request.
  • Title: Shared
    Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is true.
  • Title: Type
    Maximum Length: 30
    Default Value: FILE
    Abbreviation that identifies the data type.
  • Title: Description
    Maximum Length: 255
    Description of the attachment for the advanced shipment notice (ASN) line request.
  • Maximum Length: 255
    Value that uniquely identifies the content server document.
  • Title: Dm Folder Path
    Maximum Length: 1000
    Folder path of the attachment.
  • Maximum Length: 255
    Number that identifies a particular version of the content server document.
  • Title: DownloadInfo
    JSON-formatted string containing information required to programmatically retrieve a large file attachment.
  • Title: Error Status Code
    Abbreviation that identifies the error code, if any, for the attachment for the advanced shipment notice (ASN) line request.
  • Title: Error Status Message
    Error message, if any, for the attachment for the advanced shipment notice (ASN) line request.
  • Title: Expiration Date
    Date when the contents in the attachment for the advanced shipment notice (ASN) line request expire.
  • Title: File Contents
    Contents of the attachment for the advanced shipment notice (ASN) line request.
  • Title: File Name
    Maximum Length: 2048
    File name of the attachment for the advanced shipment notice (ASN) line request.
  • Title: File Url
    URL (Uniform Resource Locator) of the attachment for the advanced shipment notice (ASN) line request.
  • Title: Title
    Title of the attachment for the advanced shipment notice (ASN) line request.
  • Title: Uploaded File Content Type
    Content type of the attachment for the advanced shipment notice (ASN) line request.
  • Title: File Size
    Length of the attachment file for the advanced shipment notice (ASN) line request.
  • Title: Uploaded File Name
    Name of the attachment file for the advanced shipment notice (ASN) line request.
  • Title: Uploaded Text
    Text of the attachment for the advanced shipment notice (ASN) line request.
  • Title: Uri
    Maximum Length: 4000
    URI (Uniform Resource Identifier) that identifies the attachment.
  • Title: Url
    Maximum Length: 4000
    URL (Uniform Resource Locator) that locates the attachment for the advanced shipment notice (ASN) line request.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : receivingReceiptRequests-attachments-item-response
Type: object
Show Source
  • Title: Asynchronous Upload Tracker Id
    Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
  • Title: Attached Document Id
    Value that uniquely identifies the attachment of a shipment line. It is a primary key that the application generates when a document is attached to the advanced shipment notice (ASN) line request.
  • Title: Category
    Maximum Length: 30
    Category of the attachment for the advanced shipment notice (ASN) line request.
  • Title: Shared
    Contains one of the following values: true or false. If true, then the attachment is shared. If false, then the attachment is not shared. The default value is true.
  • Title: Created By
    Read Only: true
    Maximum Length: 255
    User who created the attachment.
  • Title: Created By User Name
    Read Only: true
    Login that the user used when creating the attachment for the specification.
  • Title: Creation Date
    Read Only: true
    Date when the user created the attachment record.
  • Title: Type
    Maximum Length: 30
    Default Value: FILE
    Abbreviation that identifies the data type.
  • Title: Description
    Maximum Length: 255
    Description of the attachment for the advanced shipment notice (ASN) line request.
  • Maximum Length: 255
    Value that uniquely identifies the content server document.
  • Title: Dm Folder Path
    Maximum Length: 1000
    Folder path of the attachment.
  • Maximum Length: 255
    Number that identifies a particular version of the content server document.
  • Title: DownloadInfo
    JSON-formatted string containing information required to programmatically retrieve a large file attachment.
  • Title: Error Status Code
    Abbreviation that identifies the error code, if any, for the attachment for the advanced shipment notice (ASN) line request.
  • Title: Error Status Message
    Error message, if any, for the attachment for the advanced shipment notice (ASN) line request.
  • Title: Expiration Date
    Date when the contents in the attachment for the advanced shipment notice (ASN) line request expire.
  • Title: File Contents
    Contents of the attachment for the advanced shipment notice (ASN) line request.
  • Title: File Name
    Maximum Length: 2048
    File name of the attachment for the advanced shipment notice (ASN) line request.
  • Title: File Url
    URL (Uniform Resource Locator) of the attachment for the advanced shipment notice (ASN) line request.
  • 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.
  • Title: Last Update Date
    Read Only: true
    Date and time when the user most recently updated the document that is attached to the receipt header.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 255
    Login of the user who updated the document that is attached to the receipt header.
  • Title: Last Updated By User
    Read Only: true
    Login that the user used when updating the attachment for the specification.
  • Links
  • Title: Title
    Title of the attachment for the advanced shipment notice (ASN) line request.
  • Title: Uploaded File Content Type
    Content type of the attachment for the advanced shipment notice (ASN) line request.
  • Title: File Size
    Length of the attachment file for the advanced shipment notice (ASN) line request.
  • Title: Uploaded File Name
    Name of the attachment file for the advanced shipment notice (ASN) line request.
  • Title: Uploaded Text
    Text of the attachment for the advanced shipment notice (ASN) line request.
  • Title: Uri
    Maximum Length: 4000
    URI (Uniform Resource Identifier) that identifies the attachment.
  • Title: Url
    Maximum Length: 4000
    URL (Uniform Resource Locator) that locates the attachment for the advanced shipment notice (ASN) line request.
  • Title: User Name
    Read Only: true
    Maximum Length: 255
    Login that the user used when adding or modifying the attachment.
Back to Top

Examples

This example describes how to create receipt header attachments.

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/receivingReceiptRequests/HeaderInterfaceId/child/attachments"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
	"ReceiptSourceCode": "VENDOR",
	"OrganizationCode": "M1",
	"VendorName": "PennyPack Systems",
	"VendorSiteCode": "FRESNO",
	"BusinessUnit": "Vision Operations",
	"EmployeeId": "25"
	"DFF": [
	{
		"newseg": "abc",
		"__FLEX_Context": "newctx",
		"newctxseg": "a"
	}
	],
	"lines": [
	{
		"ReceiptSourceCode": "VENDOR",
		"SourceDocumentCode": "PO",
		"TransactionType": "RECEIVE",
		"AutoTransactCode": "RECEIVE",
		"OrganizationCode": "M1",
		"DocumentNumber": 1000125,
		"DocumentLineNumber": 1,
		"ItemNumber": "RCV-100",
		"ItemId": "663907",
		"Quantity": 3,
		"UnitOfMeasure": "Each",
		"SoldtoLegalEntity": "Vision Operations",
		"transactionAttachments": [
		{
			"DatatypeCode": "TEXT",
			"Description": "TEXT created from REST",
			"UploadedText": "Sample Text test",
			"CategoryName": "MISC",
			"UploadedFileLength": "19"
		}
		],
		"transactionDFF": [
		{
			"newseg": "abc",
			"__FLEX_Context": "newctx",
			"newctxseg": "a"
		}
		]
	},
	{
		"ReceiptSourceCode": "VENDOR",
		"SourceDocumentCode": "PO",
		"TransactionType": "RECEIVE",
		"AutoTransactCode": "RECEIVE",
		"OrganizationCode": "M1",
		"DocumentNumber": 1000125,
		"DocumentLineNumber": 2,
		"ItemNumber": "RCV-101",
		"Quantity": 3,
		"UnitOfMeasure": "Each",
		"SoldtoLegalEntity": "Vision Operations",
		"lotItemLots": [
		{
			"LotNumber": "LOT18-18068",
			"TransactionQuantity": 3,
			"lotNumbersDFF": [
			{
				"newseg": "abc",
				"__FLEX_Context": "newctx",
				"newctxseg": "a"
			}
			],
			"lotAttributesDFF": [
			{
				"newseg": "abc",
				"__FLEX_Context": "newctx",
				"newctxseg": "a"
			}
			]
		}
		],
		"transactionDFF": [
		{
			"newseg": "abc",
			"__FLEX_Context": "newctx",
			"newctxseg": "a"
		}
		]
	},
	{
		"ReceiptSourceCode": "VENDOR",
		"SourceDocumentCode": "PO",
		"TransactionType": "RECEIVE",
		"AutoTransactCode": "RECEIVE",
		"OrganizationCode": "M1",
		"DocumentNumber": 1000125,
		"DocumentLineNumber": 3,
		"ItemNumber": "RCV-102",
		"Quantity": 3,
		"UnitOfMeasure": "Each",
		"SoldtoLegalEntity": "Vision Operations",
		"serialItemSerials": [
		{
			"FromSerialNumber": "S1-180630",
			"ToSerialNumber": "S1-180632",
			"serialNumbersDFF": [
			{
				"newseg": "abc",
				"__FLEX_Context": "newctx",
				"newctxseg": "a"
			}
			],
			"serialAttributesDFF": [
			{
				"newseg": "abc",
				"__FLEX_Context": "newctx",
				"newctxseg": "a"
			}
			]
		}
		],
		"transactionDFF": [
		{
			"newseg": "abc",
			"__FLEX_Context": "newctx",
			"newctxseg": "a"
		}
		]
	},
	{
		"ReceiptSourceCode": "VENDOR",
		"SourceDocumentCode": "PO",
		"TransactionType": "RECEIVE",
		"AutoTransactCode": "RECEIVE",
		"OrganizationCode": "M1",
		"DocumentNumber": 1000125,
		"DocumentLineNumber": 8,
		"ItemNumber": "VC110",
		"Quantity": 3,
		"UnitOfMeasure": "Each",
		"SoldtoLegalEntity": "Vision Operations",
		"lotSerialItemLots": [
		{
			"LotNumber": "LOT1180609",
			"TransactionQuantity": 3,
			"lotSerialItemSerials": [
			{
				"FromSerialNumber": "S1180659",
				"ToSerialNumber": "S1180661",
				"serialAttributesDFF": [
				{
					"newseg": "abc",
					"__FLEX_Context": "newctx",
					"newctxseg": "a"
				}
				],
				"serialNumbersDFF": [
				{
					"newseg": "abc",
					"__FLEX_Context": "newctx",
					"newctxseg": "a"
				}
				]
			}
			],
			"lotAttributesDFF": [
			{
				"newseg": "abc",
				"__FLEX_Context": "newctx",
				"newctxseg": "a"
			}
			],
			"lotNumbersDFF": [
			{
				"newseg": "abc",
				"__FLEX_Context": "newctx",
				"newctxseg": "a"
			}
			]
		}
		],
		"transactionDFF": [
		{
			"newseg": "abc",
			"__FLEX_Context": "newctx",
			"newctxseg": "a"
		}
		]
	}
	]
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
	"HeaderInterfaceId": 300100175669363,
	"ASNType": "STD",
	"CreatedBy": "WHSE_MGR_M1",
	"CreationDate": "2018-09-25T08:05:15.013+00:00",
	"LastUpdateDate": "2018-09-25T08:05:16.220+00:00",
	"LastUpdatedBy": "WHSE_MGR_M1",
	"ReceiptSourceCode": "VENDOR",
	"TransactionDate": null,
	"ShipmentNumber": null,
	"ReceiptNumber": "33817",
	"ReceiptHeaderId": 2989633,
	"VendorName": "PennyPack Systems",
	"VendorNumber": "1013",
	"VendorId": 21,
	"VendorSiteCode": "FRESNO",
	"VendorSiteId": 1969,
	"BusinessUnitId": 204,
	"BusinessUnit": "Vision Operations",
	"OrganizationCode": "M1",
	"OrganizationId": 207,
	"ShippedDate": null,
	"ExpectedReceiptDate": "2018-09-25",
	"FreightTerms": null,
	"FreightCarrierId": null,
	"FreightCarrierName": null,
	"NumberOfPackingUnits": null,
	"BillOfLading": null,
	"WaybillAirbillNumber": null,
	"PackingSlip": null,
	"PackagingCode": null,
	"SpecialHandlingCode": null,
	"TarWeight": null,
	"TarWeightUOMCode": null,
	"TarWeightUnitOfMeasure": null,
	"NetWeight": null,
	"NetWeightUOMCode": null,
	"NetWeightUnitOfMeasure": null,
	"Comments": null,
	"CustomerPartyName": null,
	"CustomerPartyNumber": null,
	"CustomerId": null,
	"EmployeeName": "Smith, Ms. Pat",
	"EmployeeId": 25,
	"FromOrganizationCode": null,
	"FromOrganizationId": null,
	"RMASourceSystemId": null,
	"RMASourceSystemName": null,
	"GroupId": 163412,
	"ProcessingStatusCode": "SUCCESS",
	"GLDate": "2018-09-25",
	"InvoiceDate": null,
	"InvoiceNumber": null,
	"TotalInvoiceAmount": null,
	"FreightAmount": null,
	"TaxAmount": null,
	"PaymentTermsId": null,
	"PaymentTermsName": null,
	"CurrencyCode": null,
	"InsertAndProcessFlag": "true",
	"ReturnStatus": "SUCCESS",
	"SaveAndSubmitFlag": "false",
	"DFF": [
	{
		"HeaderInterfaceId": 300100175669363,
		"_Global__Segment": null,
		"_zBIADFF1": null,
		"_BI_2DGlob_2DRH": null,
		"newseg": "abc",
		"__FLEX_Context": "newctx",
		"__FLEX_Context_DisplayValue": "newctx",
		"newctxseg": "a",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363/child/DFF/300100175669363",
			"name": "DFF",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363/child/DFF/300100175669363",
			"name": "DFF",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363",
			"name": "receivingReceiptRequests",
			"kind": "item"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363/child/DFF/300100175669363/lov/LVVO___FLEX_Context",
			"name": "LVVO___FLEX_Context",
			"kind": "collection"
		}
		],
	}
	],
	"lines": [
	{},
	{},
	{},
	{}
	],
	"attachments": [
	{
		"AttachedDocumentId": 300100175669365,
		"LastUpdateDate": "2018-09-25T08:05:19.636+00:00",
		"LastUpdatedBy": "WHSE_MGR_M1",
		"DatatypeCode": "FILE",
		"FileName": "headerAttachments.txt",
		"DmFolderPath": null,
		"Url": null,
		"CategoryName": "MISC",
		"UserName": "Miscellaneous",
		"Uri": null,
		"FileUrl": "/content/conn/FusionAppsContentRepository/uuid/dDocID%3a23398?XFND_SCHEME_ID=1&XFND_CERT_FP=D84395567668D096754572972566AC6E59C9A9C8&XFND_RANDOM=-8793838422033064660&XFND_EXPIRES=1537863371046&XFND_SIGNATURE=QoLMGC5f-NXzcJTNFO1tpaUCf~7cBYbhOxDx5F~hQ2tZuvAH-WS930BOVyW4xjQk4ABHN14hrV5XQKpzTyDSCa3FhDj6U5tGBbIYesHXpFWLVcrcyjAiqN7llKReTcv-6T1jWjqHvOZi-K-KEMJ7S3esxbN1XtbKRb-EdjaBK76Ybo4bAY-rPAx3MQdHx2d~EC0ciBv6YaU9SsKrgjxLyCnm3xDwepVzWgSwCQJQ-N8x9K62LrmdXbm-wfMlmZGiEX4sFBlSVNMNIpoJywKQuiczF9INBLtNqM0N01CFD4ab9WzLDQmwRAe0vdu0fj-rS915eqe4gA6eO0GssqblaQ__&Id=23398&download",
		"UploadedText": null,
		"UploadedFileContentType": "text/plain",
		"UploadedFileLength": 25,
		"UploadedFileName": "headerAttachments.txt",
		"ContentRepositoryFileShared": "false",
		"Title": "HeaderAttachments.txt",
		"Description": "TEXT UPLOAD from REST",
		"ErrorStatusCode": null,
		"ErrorStatusMessage": null,
		"CreatedBy": "WHSE_MGR_M1",
		"CreationDate": "2018-09-25T08:05:15.044+00:00",
		"ExpirationDate": null,
		"LastUpdatedByUserName": "John Johnson",
		"CreatedByUserName": "John Johnson",
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363/child/attachments/00020000000EACED00057708000110F0845E28750000000EACED00057708000110F0845E2874",
			"name": "attachments",
			"kind": "item"
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363/child/attachments/00020000000EACED00057708000110F0845E28750000000EACED00057708000110F0845E2874",
			"name": "attachments",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363",
			"name": "receivingReceiptRequests",
			"kind": "item"
		},
		{
			"rel": "enclosure",
			"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363/child/attachments/00020000000EACED00057708000110F0845E28750000000EACED00057708000110F0845E2874/enclosure/FileContents",
			"name": "FileContents",
			"kind": "other"
		}
		],
	}
	],
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363",
		"name": "receivingReceiptRequests",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363",
		"name": "receivingReceiptRequests",
		"kind": "item"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363/child/DFF",
		"name": "DFF",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363/child/lines",
		"name": "lines",
		"kind": "collection"
	},
	{
		"rel": "child",
		"href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100175669363/child/attachments",
		"name": "attachments",
		"kind": "collection"
	}
	],
}
Back to Top