Jump to

• Request
• Response
• Examples

Get all person notes

get

/hcmRestApi/resources/11.13.18.05/personNotes

Request

Query Parameters

• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• 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 all the note that matches the primary key criteria specified.
    Finder Variables
    • NoteId; integer; Identifier for a note.
  • findByContextIdAndContextType Finds all notes that have the specified context type and context identifier.
    Finder Variables
    • ContextId; integer; Identifier for a context identifier.
    • ContextTypeDB; string; Identifier for a context type.
    • SysEffectiveDate; object;
  • findFeedbackForCheckinTopics Finds all the notes that have a visibility code of ALL or MANAGERS_AND_SUBJECT for the specified worker and aren't already associated with the specified check-in meeting.
    Finder Variables
    • CheckInMeetingId; integer; Identifier for a check-in meeting.
    • SysEffectiveDate; object;
    • WorkerId; integer; Identifier for a worker.
• 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:
  

  • AuthorId; integer; Person identifier of the author of the note.
  • AuthorKnownAs; string; Preferred name of the author of the note.
  • AuthorName; string; Name of the note author.
  • CardTitle; string; Card title of a celebration note.
  • ContextId; integer; Context identifier of the note.
  • ContextId2; integer; Additional context identifier of the note.
  • ContextType; string; Context type of the note. Supply value is ORA_NO_CONTEXT.
  • ContextType2; string; Additional context type of the note.
  • CreatedBy; string; User who created the note.
  • CreationDate; string; Date and time when the note was created.
  • DeleteNonAuthorFlag; boolean; Indicates whether a user who isn't the author of the note has the Delete privilege. The default value is false.
  • ForeignKeyReferenceFlag; boolean; Indicates whether another application has created a reference to a note. The default value is false.
  • HiddenFlag; boolean; Indicates whether the note is hidden or shown. The default value is Show.
  • HideShowFlag; boolean; Indicates whether a user has the Hide or Show privilege. The default value is false.
  • HideShowNonRecipientFlag; boolean; Indicates whether a user who isn't the recipient or the author of the note has the Hide or Show privilege. The default value is false.
  • ImageReferenceURL; string; Image reference URL of a celebration note.
  • LastUpdateDate; string; Date and time when the note was last updated.
  • LastUpdatedBy; string; User who last updated the note.
  • NoteId; integer; System-generated primary key of the note.
  • NoteVisibilityCode; string; Visibility of the note. Valid options are: ALL, MANAGERS, MANAGERS_AND_SUBJECT, PRIVATE, SUBJECT, MANAGERS_SUBJECT_PEERS. Administrators can remove any of the options via configuration for the specified context type.
  • NoteVisibilityMeaning; string; Meaning of the visibility code.
  • ThankYouFlag; boolean; Indicates whether the user can send a thank you note. The default value is false.
  • WorkerId; integer; Person identifier of the worker who's the subject of the note.
  • WorkerKnownAs; string; Preferred name of the worker who's the subject of the note.
  • WorkerName; string; Name of the worker who's the subject of the note.
• 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

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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 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 : personNotes

Type: object

Show Source

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

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/personNotes-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object personNotes-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/personNotes-item-response"
    }
}

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 : personNotes-item-response

Type: object

Show Source

• attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• AuthorId: integer (int64)
  Title: Author Person ID

  Person identifier of the author of the note.
• AuthorKnownAs: string
  Title: Author Preferred Name

  Read Only: true

  Maximum Length: 80

  Preferred name of the author of the note.
• AuthorName: string
  Title: Author Name

  Read Only: true

  Maximum Length: 240

  Name of the note author.
• AuthorNumber: string
  Title: Author Person Number

  Maximum Length: 30

  Unique person identifier of the author of the note.
• CardTitle: string
  Maximum Length: 500

  Card title of a celebration note.
• ContextId: integer (int64)
  Context identifier of the note.
• ContextId2: integer (int64)
  Additional context identifier of the note.
• ContextType: string
  Title: Context Type

  Context type of the note. Supply value is ORA_NO_CONTEXT.
• ContextType2: string
  Maximum Length: 30

  Additional context type of the note.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the note.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the note was created.
• DeleteNonAuthorFlag: boolean
  Indicates whether a user who isn't the author of the note has the Delete privilege. The default value is false.
• ForeignKeyReferenceFlag: boolean
  Indicates whether another application has created a reference to a note. The default value is false.
• HiddenFlag: boolean
  Title: Hide

  Maximum Length: 1

  Default Value: false

  Indicates whether the note is hidden or shown. The default value is Show.
• HideShowFlag: boolean
  Indicates whether a user has the Hide or Show privilege. The default value is false.
• HideShowNonRecipientFlag: boolean
  Indicates whether a user who isn't the recipient or the author of the note has the Hide or Show privilege. The default value is false.
• ImageReferenceURL: string
  Maximum Length: 4000

  Image reference URL of a celebration note.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the note was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the note.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoteId: integer (int64)
  Title: Note ID

  System-generated primary key of the note.
• NoteText: string (byte)
  Title: Note Text

  Text of the note.
• NoteVisibilityCode: string
  Title: Note Visibility Code

  Maximum Length: 30

  Visibility of the note. Valid options are: ALL, MANAGERS, MANAGERS_AND_SUBJECT, PRIVATE, SUBJECT, MANAGERS_SUBJECT_PEERS. Administrators can remove any of the options via configuration for the specified context type.
• NoteVisibilityMeaning: string
  Maximum Length: 255

  Meaning of the visibility code.
• ThankYouFlag: boolean
  Indicates whether the user can send a thank you note. The default value is false.
• WorkerId: integer (int64)
  Title: Worker Person ID

  Person identifier of the worker who's the subject of the note.
• WorkerKnownAs: string
  Title: Worker Preferred Name

  Read Only: true

  Maximum Length: 80

  Preferred name of the worker who's the subject of the note.
• WorkerName: string
  Title: Worker Name

  Read Only: true

  Maximum Length: 240

  Name of the worker who's the subject of the note.
• WorkerNumber: string
  Title: Worker Person Number

  Maximum Length: 30

  Unique person identifier of the worker who's the subject of the note.

{
    "type":"object",
    "properties":{
        "DeleteNonAuthorFlag":{
            "type":"boolean",
            "description":"Indicates whether a user who isn't the author of the note has the Delete privilege. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the note was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/personNotes-attachments-item-response"
            }
        },
        "AuthorName":{
            "title":"Author Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the note author.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteText":{
            "title":"Note Text",
            "type":"string",
            "description":"Text of the note.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ContextId2":{
            "type":"integer",
            "description":"Additional context identifier of the note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ImageReferenceURL":{
            "maxLength":4000,
            "type":"string",
            "description":"Image reference URL of a celebration note.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkerKnownAs":{
            "title":"Worker Preferred Name",
            "maxLength":80,
            "type":"string",
            "description":"Preferred name of the worker who's the subject of the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AuthorNumber":{
            "title":"Author Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Unique person identifier of the author of the note.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ThankYouFlag":{
            "type":"boolean",
            "description":"Indicates whether the user can send a thank you note. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "HideShowFlag":{
            "type":"boolean",
            "description":"Indicates whether a user has the Hide or Show privilege. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the note.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"System-generated primary key of the note.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContextType":{
            "title":"Context Type",
            "type":"string",
            "description":"Context type of the note. Supply value is ORA_NO_CONTEXT.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AuthorId":{
            "title":"Author Person ID",
            "type":"integer",
            "description":"Person identifier of the author of the note.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NoteVisibilityCode":{
            "title":"Note Visibility Code",
            "maxLength":30,
            "type":"string",
            "description":"Visibility of the note. Valid options are: ALL, MANAGERS, MANAGERS_AND_SUBJECT, PRIVATE, SUBJECT, MANAGERS_SUBJECT_PEERS. Administrators can remove any of the options via configuration for the specified context type.",
            "nullable":true,
            "x-queryable":true
        },
        "HideShowNonRecipientFlag":{
            "type":"boolean",
            "description":"Indicates whether a user who isn't the recipient or the author of the note has the Hide or Show privilege. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkerId":{
            "title":"Worker Person ID",
            "type":"integer",
            "description":"Person identifier of the worker who's the subject of the note.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContextType2":{
            "maxLength":30,
            "type":"string",
            "description":"Additional context type of the note.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkerName":{
            "title":"Worker Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the worker who's the subject of the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AuthorKnownAs":{
            "title":"Author Preferred Name",
            "maxLength":80,
            "type":"string",
            "description":"Preferred name of the author of the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HiddenFlag":{
            "title":"Hide",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the note is hidden or shown. The default value is Show.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "NoteVisibilityMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Meaning of the visibility code.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkerNumber":{
            "title":"Worker Person Number",
            "maxLength":30,
            "type":"string",
            "description":"Unique person identifier of the worker who's the subject of the note.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ForeignKeyReferenceFlag":{
            "type":"boolean",
            "description":"Indicates whether another application has created a reference to a note. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "ContextId":{
            "type":"integer",
            "description":"Context identifier of the note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the note was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CardTitle":{
            "maxLength":500,
            "type":"string",
            "description":"Card title of a celebration note.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object personNotes-attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/personNotes-attachments-item-response"
    }
}

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 : personNotes-attachments-item-response

Type: object

Show Source

• 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

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• 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

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• 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

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name 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

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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

getBipReportUrlPrintFeedback

Operation: /hcmRestApi/resources/11.13.18.05/personNotes/action/getBipReportUrlPrintFeedback

Allows users to generate a printable feedback document.

getViewPubPersonNotePrivilege

Operation: /hcmRestApi/resources/11.13.18.05/personNotes/action/getViewPubPersonNotePrivilege

Finds out if a user has the privilege to view a person's public notes. Valid values are true and false.

Back to Top

Examples

The following example shows how to <describe action> by submitting a <method> request on the REST resource using cURL.

curl -i -u "<username>:<password> -X GET "http://host:port/hcmCoreApi/resources/11.13.18.05/personNotes?q=WorkerId=100000008153757"

Example of Response Header

The following is an example of the response header.

HTTP/1.1 200  OK
Content-Type : application/json

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
    "items": [
        {
            "NoteId": 300100182522686,
            "AuthorId": 100000008153756,
            "AuthorNumber": "8153756",
            "WorkerId": 100000008153757,
            "WorkerNumber": "8153757",
            "ContextType": "ORA_NO_CONTEXT",
            "NoteVisibilityCode": "ALL",
            "CreatedBy": "TM-MFITZIMMONS",
            "LastUpdateDate": "2019-05-03T21:49:03.027+00:00",
            "LastUpdatedBy": "TM-MFITZIMMONS",
            "CreationDate": "2019-05-03T21:49:03+00:00",
            "links": []

        },
        {
            "NoteId": 300100182522599,
            "AuthorId": 100000008153756,
            "AuthorNumber": "8153756",
            "WorkerId": 100000008153757,
            "WorkerNumber": "8153757",
            "ContextType": "ORA_NO_CONTEXT",
            "NoteVisibilityCode": "ALL",
            "CreatedBy": "TM-MFITZIMMONS",
            "LastUpdateDate": "2019-05-03T21:33:45+00:00",
            "LastUpdatedBy": "TM-MFITZIMMONS",
            "CreationDate": "2019-05-03T21:32:05+00:00",
            "links": []
        },
        {
            "NoteId": 300100182522489,
            "AuthorId": 100000008153756,
            "AuthorNumber": "8153756",
            "WorkerId": 100000008153757,
            "WorkerNumber": "8153757",
            "ContextType": "ORA_NO_CONTEXT",
            "NoteVisibilityCode": "ALL",
            "CreatedBy": "TM-MFITZIMMONS",
            "LastUpdateDate": "2019-05-03T21:11:25.020+00:00",
            "LastUpdatedBy": "TM-MFITZIMMONS",
            "CreationDate": "2019-05-03T21:11:25+00:00",
            "links": []
        },
        {
            "NoteId": 300100182522409,
            "AuthorId": 100000008153756,
            "AuthorNumber": "8153756",
            "WorkerId": 100000008153757,
            "WorkerNumber": "8153757",
            "ContextType": "ORA_NO_CONTEXT",
            "NoteVisibilityCode": "ALL",
            "CreatedBy": "TM-MFITZIMMONS",
            "LastUpdateDate": "2019-05-03T21:10:50+00:00",
            "LastUpdatedBy": "TM-MFITZIMMONS",
            "CreationDate": "2019-05-03T21:08:50+00:00",
            "links": []
        },
        {
            "NoteId": 300100179093281,
            "AuthorId": 100000008153756,
            "AuthorNumber": "8153756",
            "WorkerId": 100000008153757,
            "WorkerNumber": "8153757",
            "ContextType": "ORA_NO_CONTEXT",
            "NoteVisibilityCode": "ALL",
            "CreatedBy": "TM-MFITZIMMONS",
            "LastUpdateDate": "2019-05-03T21:07:39+00:00",
            "LastUpdatedBy": "TM-MFITZIMMONS",
            "CreationDate": "2019-04-24T01:13:14+00:00",
            "links": []
        },
        {
            "NoteId": 300100182513151,
            "AuthorId": 100000008153756,
            "AuthorNumber": "8153756",
            "WorkerId": 100000008153757,
            "WorkerNumber": "8153757",
            "ContextType": "ORA_NO_CONTEXT",
            "NoteVisibilityCode": "ALL",
            "CreatedBy": "TM-MFITZIMMONS",
            "LastUpdateDate": "2019-05-03T21:07:20+00:00",
            "LastUpdatedBy": "TM-MFITZIMMONS",
            "CreationDate": "2019-05-03T20:43:16+00:00",
            "links": []
        },
        {
            "NoteId": 300100179109622,
            "AuthorId": 100000008153756,
            "AuthorNumber": "8153756",
            "WorkerId": 100000008153757,
            "WorkerNumber": "8153757",
            "ContextType": "ORA_NO_CONTEXT",
            "NoteVisibilityCode": "MANAGERS_AND_SUBJECT",
            "CreatedBy": "TM-MFITZIMMONS",
            "LastUpdateDate": "2019-04-24T00:35:57.783+00:00",
            "LastUpdatedBy": "TM-MFITZIMMONS",
            "CreationDate": "2019-04-24T00:34:50.342+00:00",
            "links": []
        },
        {
            "NoteId": 300100179109616,
            "AuthorId": 100000008153756,
            "AuthorNumber": "8153756",
            "WorkerId": 100000008153757,
            "WorkerNumber": "8153757",
            "ContextType": "ORA_NO_CONTEXT",
            "NoteVisibilityCode": "ALL",
            "CreatedBy": "TM-MFITZIMMONS",
            "LastUpdateDate": "2019-04-24T00:34:47.045+00:00",
            "LastUpdatedBy": "TM-MFITZIMMONS",
            "CreationDate": "2019-04-24T00:33:10+00:00",
            "links": []
        }
    ],
    "count": 8,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": []
}

Back to Top