1. REST API for Oracle Supply Chain Management Cloud
  2. Tasks
  3. Product Lifecycle Management
  4. Items Version 2
  5. Item Attachments

Get all attachments

get

/fscmRestApi/resources/11.13.18.05/itemsV2/{itemsV2UniqID}/child/ItemAttachment

Request

Path Parameters
  • 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
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds item attachments according to the primary key criteria.
      Finder Variables:
      • AttachedDocumentId; integer; Value that uniquely identifies the attached document.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AttachedDocumentId; integer; An unique identifier for document that is an attachment in the repository.
    • CategoryName; string; 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.
    • CreatedBy; string; User who created the attachment.
    • CreatedByUserName; string; Login that the user used when creating the attachment.
    • CreationDate; string; Date and time when the user created the attachment.
    • DataTypeName; string; Name for the datatype of the attachment.
    • DatabaseDescription; string; Description of the file.
    • DatabaseTitle; string; Name of the file.
    • DatatypeCode; string; Abbreviation that indicates the type of data. Valid values include WEB_PAGE, TEXT, or FILE.
    • Description; string; Description of the item attachment.
    • DmDocumentId; string; Value that uniquely identifies the document in repository.
    • DmFolderPath; string; Path to the folder in which the attachment file is uploaded.
    • DmVersionNumber; string; Version number that identifies the attachment in repository.
    • DocumentPreviewURL; string; Value that represents the URL for preview of the attachment.
    • DocumentURL; string; Complete URL (Uniform Resource Locator) of the item attachment uploaded to web center.
    • EntityName; string; Value that represents the entity of the attachment.
    • ExpirationDate; string; Date when the contents of the attachment are no longer valid.
    • FileName; string; Name of the file attached to the item.
    • ItemId; string; Value that uniquely represents the item associated with the attachment.
    • LastUpdateDate; string; Date and time when the item was most recently updated. For a list of attribute value interdependencies, refer to Interdependent Item Attributes: Explained at: https://www.oracle.com/pls/topic/lookup?ctx=cloud&id=FAPIM287169.
    • LastUpdatedBy; string; User who most recently updated the attachment.
    • LastUpdatedByUserName; string; Login that the user used when updating the attachment.
    • OrganizationId; string; Represents the organization associated with the item attachment.
    • PrimaryCategoryFlag; string; Value that indicates whether the attachment is the primary attachment associated with the item revision.
    • RevisionId; string; Value that indicates the revision ID associated with the attachment.
    • Uri; string; URI (Uniform Resource Identifier) appended to the base URI derived from the endpoint associated with application identified by the MODULE_ID.
    • Url; string; Uniform resource locator of the attachment.
    • UserName; string; 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.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : itemsV2-ItemAttachment
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : itemsV2-ItemAttachment-item-response
Type: object
Show Source
Nested Schema : Flexfields for Item Attachments
Type: array
Title: Flexfields for Item Attachments
The Flexfields for Item Attachments resource manages the descriptive flexfields for item attachments.
Show Source
Nested Schema : itemsV2-ItemAttachment-AttachedDocumentsDFF-item-response
Type: object
Show Source
Back to Top