Jump to

• Request
• Response

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: 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.
• 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.

{
    "type":"object",
    "properties":{
        "FileURL":{
            "title":"File URL",
            "type":"string",
            "description":"The URL for the attached file.",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"Description of the attached file.",
            "nullable":true,
            "x-queryable":false
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attached file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "DatatypeCode":{
            "title":"Data Type Code",
            "type":"string",
            "description":"Unique identifier for the data type code for an attachment.",
            "nullable":false,
            "x-queryable":false
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Type of content for the attached file, for example text or plain.",
            "nullable":true,
            "x-queryable":false
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        },
        "HeyCategoryCode":{
            "title":"HEY Category Code",
            "maxLength":30,
            "type":"string",
            "description":"User-defined code that indicates the higher education attachment type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "LabelFromField":"HeyCategoryMeaning"
            }
        },
        "AttachmentMetadata":{
            "title":"Attachment Metadata",
            "maxLength":4000,
            "type":"string",
            "description":"Additional information about the attachment stored and utilized by the owning functional area.",
            "nullable":true
        },
        "FileName":{
            "title":"File Name",
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":false,
            "x-queryable":false
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attached file.",
            "nullable":true,
            "x-queryable":false
        },
        "PkOneValue":{
            "title":"Primary Key Value 1",
            "maxLength":150,
            "type":"string",
            "description":"First primary key of the business object the attachment is associated with.",
            "nullable":true
        }
    }
}

Back to Top

Response

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.

Body ()

Root Schema : admissionApplications-applicationAttachments-item-response

Type: object

Show Source

• 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.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.
• 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.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"Description of the attached file.",
            "nullable":true,
            "x-queryable":false
        },
        "DatatypeCode":{
            "title":"Data Type Code",
            "type":"string",
            "description":"Unique identifier for the data type code for an attachment.",
            "nullable":false,
            "x-queryable":false
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        },
        "AttachmentMetadata":{
            "title":"Attachment Metadata",
            "maxLength":4000,
            "type":"string",
            "description":"Additional information about the attachment stored and utilized by the owning functional area.",
            "nullable":true,
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "type":"string",
            "description":"Name of the attached file.",
            "nullable":false,
            "x-queryable":false
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"Title of the attached file.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceObjectMeaning":{
            "title":"Source Object Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of source object.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "HeyAttachmentId":{
            "title":"HEY Attachment ID",
            "type":"integer",
            "description":"Unique identifier for higher education attachment.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "FileURL":{
            "title":"File URL",
            "type":"string",
            "description":"The URL for the attached file.",
            "nullable":true,
            "x-queryable":false
        },
        "LockedFlag":{
            "title":"Locked Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates the attachment can't be modified or deleted.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "HeyCategoryMeaning":{
            "title":"HEY Category",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of category code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"Contents of the attached file.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"Person trading community architecture party identifier associated with the attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"Type of content for the attached file, for example text or plain.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "maxLength":30,
            "type":"string",
            "description":"Identifies the business object the attachment is associated with.",
            "nullable":false,
            "x-hints":{
                "LabelFromField":"SourceObjectMeaning"
            },
            "x-queryable":true
        },
        "HeyCategoryCode":{
            "title":"HEY Category Code",
            "maxLength":30,
            "type":"string",
            "description":"User-defined code that indicates the higher education attachment type.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "LabelFromField":"HeyCategoryMeaning"
            },
            "x-queryable":true
        },
        "ActivatedFlag":{
            "title":"Activated Indicator",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the attachment is activated or pending activation.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PkOneValue":{
            "title":"Primary Key Value 1",
            "maxLength":150,
            "type":"string",
            "description":"First primary key of the business object the attachment is associated with.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

heyCategoryCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

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

Back to Top