Get one attachment

get

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

Request

Path Parameters
  • Value that uniquely identifies the receipt request header.
  • This is the hash key of the attributes which make up the composite key for the Attachments for Receipt Header Requests resource and used to uniquely identify an instance of Attachments for Receipt Header Requests. The client should not generate the hash key value. Instead, the client should query on the Attachments for Receipt Header Requests collection resource in order to navigate to a specific instance of Attachments for Receipt Header Requests to get the hash key.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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.

There's no request body for this operation.

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 get one attachment.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/HeaderInterfaceId/child/attachments/AttachedDocumentId"

For example, the following command gets one attachment:

curl -u username:password "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169632511/child/attachments/00020000000EACED00057708000110F084020B010000000EACED00057708000110F084020B00"

Example Response Body

The following shows an example of the response body in JSON format.

{
    "AttachedDocumentId": 300100169538364,
    "LastUpdateDate": "2018-11-01T08:42:47.959+00:00",
    "LastUpdatedBy": "WHSE_MGR_M1",
    "DatatypeCode": "WEB_PAGE",
    "FileName": null,
    "DmFolderPath": null,
    "Url": "https://www.example.com",
    "CategoryName": "MISC",
    "UserName": "Miscellaneous",
    "Uri": null,
    "FileUrl": null,
    "UploadedText": null,
    "UploadedFileContentType": null,
    "UploadedFileLength": null,
    "UploadedFileName": null,
    "ContentRepositoryFileShared": "false",
    "Title": "Link to google.in",
    "Description": "WEB_PAGE created from REST",
    "ErrorStatusCode": null,
    "ErrorStatusMessage": null,
    "CreatedBy": "WHSE_MGR_M1",
    "CreationDate": "2018-11-01T08:42:47.051+00:00",
    "ExpirationDate": null,
    "LastUpdatedByUserName": "John Johnson",
    "CreatedByUserName": "John Johnson",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169538362/child/attachments/00020000000EACED00057708000110F084009B3C0000000EACED00057708000110F084009B3B",
            "name": "attachments",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169538362/child/attachments/00020000000EACED00057708000110F084009B3C0000000EACED00057708000110F084009B3B",
            "name": "attachments",
            "kind": "item"
        },
        {
            "rel": "parent",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169538362",
            "name": "receivingReceiptRequests",
            "kind": "item"
        },
        {
            "rel": "enclosure",
            "href": "https://servername/fscmRestApi/resources/version/receivingReceiptRequests/300100169538362/child/attachments/00020000000EACED00057708000110F084009B3C0000000EACED00057708000110F084009B3B/enclosure/FileContents",
            "name": "FileContents",
            "kind": "other"
        }
    ]
}
Back to Top