Get all attachments for a deliverable
get
/fscmRestApi/resources/11.13.18.05/deliverables/{DeliverableId}/child/Attachment
Request
Path Parameters
- DeliverableId(required): integer(int64) Identifier of the deliverable. This field is mandatory for PATCH and DELETE operations.
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: Find the attachment with the specified attachment ID.
Finder Variables:- AttachedDocumentId; integer; Identifier of the attachment to the deliverable.
- PrimaryKey: Find the attachment with the specified attachment ID.
- 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:- AttachedDocumentId; integer; Identifier of the attachment.
- CategoryName; string; Category of the attachment. For POST or PATCH operations, the value must be Project Deliverable.
- CreatedBy; string; Name of the person who originally created the attachment. In POST or PATCH operation it is automatically populated as the name of the user who creates the attachment.
- CreatedByUserName; string; Name of the person who created the record.
- CreationDate; string; Date when the attachment was originally created. It is automatically populated as the date attachment was created.
- DatatypeCode; string; Type of attachment. Values are FILE, WEB_PAGE, or TEXT. Default value is TEXT. It is mandatory in POST operations.
- DmDocumentId; string; The unique identifier of the attachment.
- DmFolderPath; string; The path to the folder where the uploaded file is stored.
- DmVersionNumber; string; The version number of the attachment.
- ExpirationDate; string; Expiration date of the file on the file content server.
- FileName; string; Name of the file if the attachment type is File, or the text itself if the attachment type is File. It is mandatory in POST operations if the attachment type is File or Text.
- LastUpdateDate; string; Date when the attachment was last updated. In POST or PATCH operation it is automatically populated as the current date.
- LastUpdatedBy; string; Name of the person who last updated the attachment. In POST or PATCH operation it is automatically populated as the name of the user who updates the attachment.
- LastUpdatedByUserName; string; Name of the person who last updated the record.
- Uri; string; Universal resource identifier, which is a unique identifier of the location on the Internet.
- Url; string; Universal Resource Locator, if the attachment type is URL. It is mandatory in POST operations if the attachment type is URL.
- UserName; string; Category code of the attachment. For POST or PATCH operations, the value must be PROJECT_DELIVERABLE.
- 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: string 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: string 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 : deliverables-Attachment
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 : deliverables-Attachment-item-response
Type:
Show Source object
- AsyncTrackerId: string Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. - AttachedDocumentId: integer (int64) Title:
Attached Document Id
Identifier of the attachment. - CategoryName: string Title:
Category
Maximum Length:30
Category of the attachment. For POST or PATCH operations, the value must be Project Deliverable. - ContentRepositoryFileShared: boolean
- CreatedBy: string Title:
Created By
Read Only:true
Maximum Length:255
Name of the person who originally created the attachment. In POST or PATCH operation it is automatically populated as the name of the user who creates the attachment. - CreatedByUserName: string Title:
Created By User Name
Read Only:true
Name of the person who created the record. - CreationDate: string (date-time) Title:
Creation Date
Read Only:true
Date when the attachment was originally created. It is automatically populated as the date attachment was created. - DatatypeCode: string Title:
Type
Maximum Length:30
Default Value:FILE
Type of attachment. Values are FILE, WEB_PAGE, or TEXT. Default value is TEXT. It is mandatory in POST operations. - Description: string Title:
Description
Maximum Length:255
Description of the attachment. - DmDocumentId: string Maximum Length:
255
The unique identifier of the attachment. - DmFolderPath: string Title:
Dm Folder Path
Maximum Length:1000
The path to the folder where the uploaded file is stored. - DmVersionNumber: string Maximum Length:
255
The version number of the attachment. - 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 code, if the operation returns an error. - ErrorStatusMessage: string Title:
Error Status Message
Error message, if the operation returns an error. - ExpirationDate: string (date-time) Title:
Expiration Date
Expiration date of the file on the file content server. - FileContents: string (byte) Title:
File Contents
Contents of the attachment. This attribute is not being used. - FileName: string Title:
File Name
Maximum Length:2048
Name of the file if the attachment type is File, or the text itself if the attachment type is File. It is mandatory in POST operations if the attachment type is File or Text. - FileUrl: string Title:
File Url
Location on the file content server of the attached document or text. This is null if the attachment type is URL. - FileWebImage: string (byte) 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. - LastUpdateDate: string (date-time) Title:
Last Update Date
Read Only:true
Date when the attachment was last updated. In POST or PATCH operation it is automatically populated as the current date. - LastUpdatedBy: string Title:
Last Updated By
Read Only:true
Maximum Length:255
Name of the person who last updated the attachment. In POST or PATCH operation it is automatically populated as the name of the user who updates the attachment. - LastUpdatedByUserName: string Title:
Last Updated By User
Read Only:true
Name of the person who last updated the record. - links: array Links Title:
Links
The link relations associated with the resource instance. - PostProcessingAction: string Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. - Title: string Title:
Title
Title of the attachment. - UploadedFileContentType: string Title:
Uploaded File Content Type
Type of file uploaded as attachment, such as text, or Excel document. It is mandatory in POST operations if the attachment type is File. - UploadedFileLength: integer Title:
File Size
Size of the file uploaded as attachment. This is null if the attachment type is URL. - UploadedFileName: string Title:
Uploaded File Name
Name of the attachment file. This attribute is not being used. - UploadedText: string Title:
Uploaded Text
Text of the attachment. This attribute is not being used. - Uri: string Title:
Uri
Maximum Length:4000
Universal resource identifier, which is a unique identifier of the location on the Internet. - Url: string Title:
Url
Maximum Length:4000
Universal Resource Locator, if the attachment type is URL. It is mandatory in POST operations if the attachment type is URL. - UserName: string Title:
User Name
Read Only:true
Maximum Length:255
Category code of the attachment. For POST or PATCH operations, the value must be PROJECT_DELIVERABLE.
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.
Examples
The following example shows how to get all attachments by submitting a GET request on the REST resource using cURL.
curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/deliverables/300100124950046/child/Attachment
Example of Response Body
The following shows an example of the response body in JSON format.
{ "AttachedDocumentId": 300100126604725, "LastUpdateDate": "2018-06-05T16:40:25.067+00:00", "LastUpdatedBy": "Connor.Horton", "DatatypeCode": "WEB_PAGE", "FileName": null, "DmFolderPath": null, "Url": "https://servername/fscmUI/faces/AtkHomePageWelcome?_adf.ctrl-state=c25bpilzw_5", "CategoryName": "PROJECT_DELIVERABLE", "UserName": "Project Deliverable", "Uri": null, "FileUrl": null, "UploadedText": null, "UploadedFileContentType": null, "UploadedFileLength": null, "UploadedFileName": null, "ContentRepositoryFileShared": "false", "Title": "post test url updated", "Description": "url desc", "ErrorStatusCode": null, "ErrorStatusMessage": null, "CreatedBy": "Connor.Horton", "CreationDate": "2018-06-05T16:40:25+00:00", "ExpirationDate": null }