Jump to

• Request
• Response

Create a note in a journey template

post

/hcmRestApi/resources/11.13.18.05/journeys/{JourneyId}/child/notes

Request

Path Parameters

• JourneyId(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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Description: string
  Description of the task.
• EventDate: string
  Date for meeting type note.
• EventLocation: string
  Location for meeting type note.
• EventOffset: integer
  Offset value for the event.
• EventTime: string
  Time for meeting type note.
• Sequence: integer (int32)
  Task display ordering sequence. Default is 1.
• Title: string
  Title of the notes.
• Type: string
  Note subtype code. Values are from the ORA_PER_ONB_CONTENT_SBTYP_NOTE lookup. Example, Meeting Note, Standard Note.

{
    "type":"object",
    "properties":{
        "Type":{
            "type":"string",
            "description":"Note subtype code. Values are from the ORA_PER_ONB_CONTENT_SBTYP_NOTE lookup. Example, Meeting Note, Standard Note.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "EventDate":{
            "type":"string",
            "description":"Date for meeting type note.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "Description":{
            "type":"string",
            "description":"Description of the task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "EventOffset":{
            "type":"integer",
            "description":"Offset value for the event.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "EventTime":{
            "type":"string",
            "description":"Time for meeting type note.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "EventLocation":{
            "type":"string",
            "description":"Location for meeting type note.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "Title":{
            "type":"string",
            "description":"Title of the notes.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "Sequence":{
            "type":"integer",
            "description":"Task display ordering sequence. Default is 1.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        }
    }
}

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 : journeys-notes-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date the notes was created.
• Description: string
  Description of the task.
• EventDate: string
  Date for meeting type note.
• EventLocation: string
  Location for meeting type note.
• EventOffset: integer
  Offset value for the event.
• EventTime: string
  Time for meeting type note.
• JourneyNoteId: integer (int64)
  Read Only: true

  Unique identifier of the journey notes.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date the notes was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• Sequence: integer (int32)
  Task display ordering sequence. Default is 1.
• Title: string
  Title of the notes.
• Type: string
  Note subtype code. Values are from the ORA_PER_ONB_CONTENT_SBTYP_NOTE lookup. Example, Meeting Note, Standard Note.
• TypeMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Note subtype meaning.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the notes.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the notes was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "EventDate":{
            "type":"string",
            "description":"Date for meeting type note.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the notes.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "type":"string",
            "description":"Description of the task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "EventOffset":{
            "type":"integer",
            "description":"Offset value for the event.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "EventLocation":{
            "type":"string",
            "description":"Location for meeting type note.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "Title":{
            "type":"string",
            "description":"Title of the notes.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "Sequence":{
            "type":"integer",
            "description":"Task display ordering sequence. Default is 1.",
            "format":"int32",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"9"
            }
        },
        "TypeMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Note subtype meaning.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "JourneyNoteId":{
            "type":"integer",
            "description":"Unique identifier of the journey notes.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "Type":{
            "type":"string",
            "description":"Note subtype code. Values are from the ORA_PER_ONB_CONTENT_SBTYP_NOTE lookup. Example, Meeting Note, Standard Note.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "EventTime":{
            "type":"string",
            "description":"Time for meeting type note.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "sortable":false
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the notes was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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."
        }
    }
}

Back to Top