Get one attachment
get
/fscmRestApi/resources/11.13.18.05/itemsV2/{itemsV2UniqID}/child/ItemRevision/{ItemRevisionUniqID}/child/RevisionAttachment/{RevisionAttachmentUniqID}
Request
Path Parameters
-
ItemRevisionUniqID(required): string
This is the hash key of the attributes which make up the composite key--- RevisionId, OrganizationId and InventoryItemId ---for the Item Revisions resource and used to uniquely identify an instance of Item Revisions. The client should not generate the hash key value. Instead, the client should query on the Item Revisions collection resource with a filter on the primary key values in order to navigate to a specific instance of Item Revisions.
For example: ItemRevision?q=RevisionId=<value1>;OrganizationId=<value2>;InventoryItemId=<value3> -
RevisionAttachmentUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Item Revision Attachments resource and used to uniquely identify an instance of Item Revision Attachments. The client should not generate the hash key value. Instead, the client should query on the Item Revision Attachments collection resource in order to navigate to a specific instance of Item Revision Attachments to get the hash key.
-
itemsV2UniqID(required): string
This is the hash key of the attributes which make up the composite key for the Items Version 2 resource and used to uniquely identify an instance of Items Version 2. The client should not generate the hash key value. Instead, the client should query on the Items Version 2 collection resource in order to navigate to a specific instance of Items Version 2 to get the hash key.
Query Parameters
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : itemsV2-ItemRevision-RevisionAttachment-item-response
Type:
Show Source
object
-
AttachedDocumentId: integer
(int64)
An unique identifier for document that is an attachment in the repository.
-
CategoryName: string
Title:
Category
Maximum Length:30
Name of the item attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage attachment categories task. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Read Only:
true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Read Only:
true
Login that the user used when creating the attachment. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the attachment. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Not exposed in code. -
Description: string
Title:
Description
Maximum Length:255
Description of the item revision attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the document in repository. -
DmFolderPath: string
Maximum Length:
1000
Path to the folder in which the attachment file is uploaded. -
DmVersionNumber: string
Maximum Length:
255
Version number that identifies the attachment in repository. -
DocumentURL: string
Read Only:
true
Complete URL (Uniform Resource Locator) of the item attachment uploaded to web center. -
DownloadInfo: string
JSON object represented as a string containing information used to programmatically retrieve a file attachment.
-
ErrorStatusCode: string
Abbreviation that identifies the error code, if any, for the attachment.
-
ErrorStatusMessage: string
Text of the error message, if any, for the attachment.
-
ExpirationDate: string
(date-time)
Date when the contents of the attachment are no longer valid.
-
FileContents: string
(byte)
Not exposed in code.
-
FileName: string
Title:
File Name
Maximum Length:2048
Name of the file attached to the item. -
FileUrl: string
Path of the document file.
-
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the item revision attachment. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who most recently updated the attachment. -
LastUpdatedByUserName: string
Read Only:
true
Login that the user used when updating the attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
Title of the item revision attachment. -
UploadedFileContentType: string
Content type of the attached file.
-
UploadedFileLength: integer
Title:
File Size
Length of the attached file. -
UploadedFileName: string
Name of the attached file.
-
UploadedText: string
Contents of text file that is attached.
-
Uri: string
Maximum Length:
4000
URI (Uniform Resource Identifier) appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID. -
Url: string
Maximum Length:
4000
Uniform resource locator of the attachment. -
UserName: string
Read Only:
true
Maximum Length:255
Display name of the attachment category. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage attachment categories task.
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.