Update an application attachment
patch
/fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationAttachments/{HeyAttachmentId}
Request
Path Parameters
-
ApplicationId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
HeyAttachmentId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AttachmentMetadata: string
Title:
Attachment Metadata
Maximum Length:4000
Additional information about the attachment stored and utilized by the owning functional area. -
DatatypeCode: string
Title:
Data Type Code
Unique identifier for the data type code for an attachment. -
Description: string
Title:
Description
Description of the attached file. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attached file. -
FileName: string
Title:
File Name
Name of the attached file. -
FileURL: string
Title:
File URL
The URL for the attached file. -
HeyCategoryCode: string
Title:
HEY Category Code
Maximum Length:30
User-defined code that indicates the higher education attachment type. -
PkOneValue: string
Title:
Primary Key Value 1
Maximum Length:150
First primary key of the business object the attachment is associated with. -
Title: string
Title:
Title
Title of the attached file. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Type of content for the attached file, for example text or plain.
Response
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 : admissionApplications-applicationAttachments-item-response
Type:
Show Source
object
-
ActivatedFlag: boolean
Title:
Activated Indicator
Read Only:true
Maximum Length:1
Default Value:false
Indicates if the attachment is activated or pending activation. -
AttachmentMetadata: string
Title:
Attachment Metadata
Maximum Length:4000
Additional information about the attachment stored and utilized by the owning functional area. -
DatatypeCode: string
Title:
Data Type Code
Unique identifier for the data type code for an attachment. -
Description: string
Title:
Description
Description of the attached file. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attached file. -
FileName: string
Title:
File Name
Name of the attached file. -
FileURL: string
Title:
File URL
The URL for the attached file. -
HeyAttachmentId: integer
(int64)
Title:
HEY Attachment ID
Read Only:true
Unique identifier for higher education attachment. -
HeyCategoryCode: string
Title:
HEY Category Code
Maximum Length:30
User-defined code that indicates the higher education attachment type. -
HeyCategoryMeaning: string
Title:
HEY Category
Read Only:true
Maximum Length:80
Meaning of category code. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LockedFlag: boolean
Title:
Locked Indicator
Read Only:true
Maximum Length:1
Default Value:false
Indicates the attachment can't be modified or deleted. -
PartyId: integer
(int64)
Title:
Party ID
Person trading community architecture party identifier associated with the attachment. -
PkOneValue: string
Title:
Primary Key Value 1
Maximum Length:150
First primary key of the business object the attachment is associated with. -
SourceObjectCode: string
Title:
Source Object Code
Maximum Length:30
Identifies the business object the attachment is associated with. -
SourceObjectMeaning: string
Title:
Source Object Meaning
Read Only:true
Maximum Length:80
Meaning of source object. -
Title: string
Title:
Title
Title of the attached file. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Type of content for the attached file, for example text or plain.
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.
Links
- heyCategoryCodesLOV
-
Parameters:
- finder:
ByLookupTypeFinder%3BLookupType%3DORA_HEY_CATEGORY_CODE%2CLookupCode%3D{HeyCategoryCode}
The following properties are defined on the LOV link relation:- Source Attribute: HeyCategoryCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: