Get all attachments of a change order
get
/fscmRestApi/resources/11.13.18.05/productChangeOrdersV2/{productChangeOrdersV2UniqID}/child/changeOrderAttachments
Request
Path Parameters
-
productChangeOrdersV2UniqID(required): string
This is the hash key of the attributes which make up the composite key for the Product Change Orders Version 2 resource and used to uniquely identify an instance of Product Change Orders Version 2. The client should not generate the hash key value. Instead, the client should query on the Product Change Orders Version 2 collection resource in order to navigate to a specific instance of Product Change Orders 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 -
finder: string
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 a change-order attachment according to the primary key.
Finder Variables:
- PrimaryKey :Finds a change-order attachment according to the primary key.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- CategoryName; string; Category name of a change-order attachment.
- CreatedBy; string; User who created the change-order attachment.
- CreatedByUserName; string; Name of the user who created the change-order attachment.
- CreationDate; string; Date when the change object was created.
- DatatypeCode; string; Unique identifier of the datatype of the attachment.
- DmDocumentId; string; Unique identifier of the document in the repository.
- DmFolderPath; string; Attribute value that represents the repository folder path of the attachment.
- DmVersionNumber; string; Attribute value that represents the version number of the attachment in the repository.
- ExpirationDate; string; Attachment expiration date of the change order.
- FileName; string; File name of the change-order attachment.
- LastUpdateDate; string; Attribute that indicates the date and time of the last update of the attachment.
- LastUpdatedBy; string; User who last updated the change-order attachment.
- LastUpdatedByUserName; string; Name of the user who last updated the change-order attachment.
- Uri; string; An attribute value that represents the URI for the attachment.
- Url; string; An attribute value that represents the URL for the attachment.
- UserName; string; Attribute value that represents the name of user who uploaded the attachment.
-
totalResults: boolean
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
-
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:
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 : productChangeOrdersV2-changeOrderAttachments
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeOrdersV2-changeOrderAttachments-item-response
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
Category name of a change-order attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the change-order attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Name of the user who created the change-order attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the change object was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Unique identifier of the datatype of the attachment. -
Description: string
Title:
Description
Maximum Length:255
An attribute value that represents the description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Unique identifier of the document in the repository. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Attribute value that represents the repository folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Attribute value that represents the version number of the attachment in the repository. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Error status code for the change-order attachment upload. -
ErrorStatusMessage: string
Title:
Error Status Message
Error status message for the change-order attachment upload. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Attachment expiration date of the change order. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the change-order attachment. -
FileUrl: string
Title:
File Url
File URL of the change-order attachment. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Attribute that indicates the date and time of the last update of the attachment. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
User who last updated the change-order attachment. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Name of the user who last updated the change-order attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Title: string
Title:
Title
Attribute value that represents the title of a change-order attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the uploaded change-order attachment. -
UploadedFileLength: integer
Title:
File Size
File length of the uploaded change-order attachment. -
UploadedFileName: string
Title:
Uploaded File Name
File name of the uploaded change-order attachment. -
UploadedText: string
Title:
Uploaded Text
Contents of attached text file. -
Uri: string
Title:
Uri
Maximum Length:4000
An attribute value that represents the URI for the attachment. -
Url: string
Title:
Url
Maximum Length:4000
An attribute value that represents the URL for the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Attribute value that represents the name of user who uploaded the attachment.
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.