Jump to

• Request
• Response
• Examples

Add a comment

post

/api/v1/applications/{id}/comments

to the specified application.

Request

Supported Media Types

• application/json

Path Parameters

• id: integer
  The application ID.

Body ()

Comment that must be added. Only commentText is valid for creation.

Root Schema : ApplicationTrackingHistoryItem

Type: object

The base class of all the types of application tracking history items. This class contains all the common information that can be stored to know what happened to the application of the candidate.

Match All

Show Source

• object AbstractApplicationTrackingHistoryItem
  The base class of all the types of application tracking history items. With application tracking history itens we can know : when the candidate has applied on a requisition, when and what has changed in his personnal informations, when and what has change on his application, when and what was the progression of the candidate during the hiring process.
• object ApplicationTrackingHistoryItem-allOf[1]

{
    "type":"object",
    "description":"The base class of all the types of application tracking history items. This class contains all the common information that can be stored to know what happened to the application of the candidate.",
    "allOf":[
        {
            "$ref":"#/definitions/AbstractApplicationTrackingHistoryItem"
        },
        {
            "properties":{
                "commentText":{
                    "type":"string",
                    "description":"Contains the comment entered by the operator who perform an action that created an application tracking history item."
                },
                "creationDate":{
                    "type":"number",
                    "format":"int64",
                    "description":"The date on which the application tracking history item has been created."
                },
                "detail":{
                    "type":"number",
                    "format":"int64",
                    "description":"The date on which the application tracking history item has been created."
                },
                "eventDate":{
                    "type":"number",
                    "format":"int64",
                    "description":"This is the date that the operator say that the event has occured or will occured."
                },
                "event":{
                    "$ref":"#/definitions/CandidateSelectionEvent"
                },
                "message":{
                    "$ref":"#/definitions/Message"
                },
                "origin":{
                    "$ref":"#/definitions/AbstractApplicationTrackingHistoryItem"
                },
                "substitute":{
                    "$ref":"#/definitions/User"
                },
                "tokens":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ApplicationTrackingItemToken"
                    },
                    "description":"This attribute contains tokens to add detaills to the tracking history item."
                },
                "user":{
                    "$ref":"#/definitions/User"
                }
            }
        }
    ]
}

Nested Schema : AbstractApplicationTrackingHistoryItem

Type: object

The base class of all the types of application tracking history items. With application tracking history itens we can know : when the candidate has applied on a requisition, when and what has changed in his personnal informations, when and what has change on his application, when and what was the progression of the candidate during the hiring process.

Match All

Show Source

• object Entity
  Base entity type.
• object AbstractApplicationTrackingHistoryItem-allOf[1]

{
    "type":"object",
    "description":"The base class of all the types of application tracking history items. With application tracking history itens we can know : when the candidate has applied on a requisition, when and what has changed in his personnal informations, when and what has change on his application, when and what was the progression of the candidate during the hiring process.",
    "allOf":[
        {
            "$ref":"#/definitions/Entity"
        },
        {
            "properties":{
                "id":{
                    "type":"integer",
                    "format":"int64"
                }
            }
        }
    ]
}

Nested Schema : ApplicationTrackingHistoryItem-allOf[1]

Type: object

Show Source

• commentText: string
  Contains the comment entered by the operator who perform an action that created an application tracking history item.
• creationDate: number(int64)
  The date on which the application tracking history item has been created.
• detail: number(int64)
  The date on which the application tracking history item has been created.
• event: object CandidateSelectionEvent
  This class is a lookup. It contains all the possbile events that can occured when a change happened during the selection process of the candidate.
• eventDate: number(int64)
  This is the date that the operator say that the event has occured or will occured.
• message: object Message
  Log message
• origin: object AbstractApplicationTrackingHistoryItem
  The base class of all the types of application tracking history items. With application tracking history itens we can know : when the candidate has applied on a requisition, when and what has changed in his personnal informations, when and what has change on his application, when and what was the progression of the candidate during the hiring process.
• substitute: object User
• tokens: array tokens
  This attribute contains tokens to add detaills to the tracking history item.
• user: object User

{
    "properties":{
        "commentText":{
            "type":"string",
            "description":"Contains the comment entered by the operator who perform an action that created an application tracking history item."
        },
        "creationDate":{
            "type":"number",
            "format":"int64",
            "description":"The date on which the application tracking history item has been created."
        },
        "detail":{
            "type":"number",
            "format":"int64",
            "description":"The date on which the application tracking history item has been created."
        },
        "eventDate":{
            "type":"number",
            "format":"int64",
            "description":"This is the date that the operator say that the event has occured or will occured."
        },
        "event":{
            "$ref":"#/definitions/CandidateSelectionEvent"
        },
        "message":{
            "$ref":"#/definitions/Message"
        },
        "origin":{
            "$ref":"#/definitions/AbstractApplicationTrackingHistoryItem"
        },
        "substitute":{
            "$ref":"#/definitions/User"
        },
        "tokens":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ApplicationTrackingItemToken"
            },
            "description":"This attribute contains tokens to add detaills to the tracking history item."
        },
        "user":{
            "$ref":"#/definitions/User"
        }
    }
}

Nested Schema : Entity

Type: object

Base entity type.

Show Source

• key: string
  Entity key value.

{
    "type":"object",
    "description":"Base entity type.",
    "properties":{
        "key":{
            "description":"Entity key value.",
            "type":"string"
        }
    }
}

Nested Schema : AbstractApplicationTrackingHistoryItem-allOf[1]

Type: object

Show Source

• id: integer(int64)

{
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : CandidateSelectionEvent

Type: object

This class is a lookup. It contains all the possbile events that can occured when a change happened during the selection process of the candidate.

Match All

Show Source

• object ResourceLookup
  Base entity type for all resource based lookup entities in this model.
• object CandidateSelectionEvent-allOf[1]

{
    "type":"object",
    "description":"This class is a lookup. It contains all the possbile events that can occured when a change happened during the selection process of the candidate.",
    "allOf":[
        {
            "$ref":"#/definitions/ResourceLookup"
        },
        {
            "properties":{
                "code":{
                    "type":"string",
                    "description":"Public identifier of the candidate selection event."
                },
                "detailDescription":{
                    "$ref":"#/definitions/MLString"
                },
                "category":{
                    "$ref":"#/definitions/CandidateSelectionEventCategory"
                }
            }
        }
    ]
}

Nested Schema : Message

Type: object

Log message

Match All

Show Source

• object Entity
  Base entity type.
• object Message-allOf[1]

{
    "type":"object",
    "description":"Log message",
    "allOf":[
        {
            "$ref":"#/definitions/Entity"
        },
        {
            "properties":{
                "id":{
                    "type":"integer",
                    "format":"int64"
                },
                "bccText":{
                    "type":"string"
                },
                "ccText":{
                    "type":"string"
                },
                "comment":{
                    "type":"string"
                },
                "dateSent":{
                    "type":"number",
                    "format":"int64"
                },
                "fromText":{
                    "type":"string"
                },
                "toText":{
                    "type":"string"
                },
                "deliveryTransport":{
                    "$ref":"#/definitions/MessageDeliveryTransport"
                },
                "messageTemplate":{
                    "$ref":"#/definitions/MessageTemplate"
                }
            }
        }
    ]
}

Nested Schema : User

Type: object

Show Source

• city: string
  The city of the user.
• corporateEmail: string
  The corporate email address of the user.
• correspondenceEmail: string
  The correspondence email address of the user.
• country: string
  The ccountry of the user.
• departmentName: string
  The department name of the user.
• departmentNumber: integer(int32)
  The department number of the user.
• employeeID: string
  The employee ID of the user.
• fax: string
  The fax number of the user.
• firstName: string
  The first name of the user.
• homePhone: string
  The home phone number of the user.
• id: integer(int32)
  A unique internal identifier of the user.
• initial: string
  The initials of the user.
• lastName: string
  The last name of the user.
• mobilePhone: string
  The mobile phone number of the user.
• pager: string
  The pager number of the user.
• personalEmail: string
  The personal email address of the user.
• prefix: string
  The prefix of the user.
• state: string
  The state of the user.
• streetAddress: string
  The street address line 1 of the user.
• streetAddress2: string
  The street address line 2 of the user.
• streetAddress3: string
  The street address line 3 of the user.
• suffix: string
  The suffix of the user.
• systemUser: boolean
  Flag indicating if the user is a system user or a standard user.
• title: string
  The title of the user.
• workPhone: string
  The work phone number of the user.
• workPhoneExt: string
  The work phone number extension of the user.
• zipcode: string
  The zipcode of the user.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int32",
            "description":"A unique internal identifier of the user."
        },
        "city":{
            "type":"string",
            "description":"The city of the user."
        },
        "corporateEmail":{
            "type":"string",
            "description":"The corporate email address of the user."
        },
        "correspondenceEmail":{
            "type":"string",
            "description":"The correspondence email address of the user."
        },
        "country":{
            "type":"string",
            "description":"The ccountry of the user."
        },
        "departmentName":{
            "type":"string",
            "description":"The department name of the user."
        },
        "departmentNumber":{
            "type":"integer",
            "format":"int32",
            "description":"The department number of the user."
        },
        "employeeID":{
            "type":"string",
            "description":"The employee ID of the user."
        },
        "fax":{
            "type":"string",
            "description":"The fax number of the user."
        },
        "firstName":{
            "type":"string",
            "description":" The first name of the user."
        },
        "homePhone":{
            "type":"string",
            "description":" The home phone number of the user."
        },
        "initial":{
            "type":"string",
            "description":" The initials of the user."
        },
        "lastName":{
            "type":"string",
            "description":" The last name of the user."
        },
        "mobilePhone":{
            "type":"string",
            "description":" The mobile phone number of the user."
        },
        "pager":{
            "type":"string",
            "description":" The pager number of the user."
        },
        "personalEmail":{
            "type":"string",
            "description":" The personal email address of the user."
        },
        "prefix":{
            "type":"string",
            "description":" The prefix of the user."
        },
        "state":{
            "type":"string",
            "description":" The state of the user."
        },
        "streetAddress":{
            "type":"string",
            "description":" The street address line 1 of the user."
        },
        "streetAddress2":{
            "type":"string",
            "description":" The street address line 2 of the user."
        },
        "streetAddress3":{
            "type":"string",
            "description":" The street address line 3 of the user."
        },
        "suffix":{
            "type":"string",
            "description":" The suffix of the user."
        },
        "systemUser":{
            "type":"boolean",
            "description":"Flag indicating if the user is a system user or a standard user."
        },
        "title":{
            "type":"string",
            "description":" The title of the user."
        },
        "workPhone":{
            "type":"string",
            "description":" The work phone number of the user."
        },
        "workPhoneExt":{
            "type":"string",
            "description":" The work phone number extension of the user."
        },
        "zipcode":{
            "type":"string",
            "description":" The zipcode of the user."
        }
    }
}

Nested Schema : tokens

Type: array

This attribute contains tokens to add detaills to the tracking history item.

Show Source

• [0]: object ApplicationTrackingItemToken
  This class is use to store a pair of informations (token ,value) to help build the column details that is displayed into the column details. Suppose that we have a detail string that look like that : 'Hello {token_example} !!!' And suppose that we have a token 'token_example' who is value is 'World'. When the replacement will be done, we will have this detail string : Hello World !!!

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApplicationTrackingItemToken"
    },
    "description":"This attribute contains tokens to add detaills to the tracking history item."
}

Nested Schema : ResourceLookup

Type: object

Base entity type for all resource based lookup entities in this model.

Show Source

• description: string
  The textual representation of the entity.
• id: integer(int32)
  A unique internal identifier.

{
    "type":"object",
    "description":"Base entity type for all resource based lookup entities in this model.",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int32",
            "description":"A unique internal identifier."
        },
        "description":{
            "type":"string",
            "description":"The textual representation of the entity."
        }
    }
}

Nested Schema : CandidateSelectionEvent-allOf[1]

Type: object

Show Source

• category: object CandidateSelectionEventCategory
  This is a lookup class. It contains all the categories of the events that can occured when a change happened during the selection process of the candidate.
• code: string
  Public identifier of the candidate selection event.
• detailDescription: array MLString

{
    "properties":{
        "code":{
            "type":"string",
            "description":"Public identifier of the candidate selection event."
        },
        "detailDescription":{
            "$ref":"#/definitions/MLString"
        },
        "category":{
            "$ref":"#/definitions/CandidateSelectionEventCategory"
        }
    }
}

Nested Schema : CandidateSelectionEventCategory

Type: object

This is a lookup class. It contains all the categories of the events that can occured when a change happened during the selection process of the candidate.

Match All

Show Source

• object ResourceLookup
  Base entity type for all resource based lookup entities in this model.
• object CandidateSelectionEventCategory-allOf[1]

{
    "type":"object",
    "description":"This is a lookup class. It contains all the categories of the events that can occured when a change happened during the selection process of the candidate.",
    "allOf":[
        {
            "$ref":"#/definitions/ResourceLookup"
        },
        {
            "properties":{
                "code":{
                    "type":"string",
                    "description":"Public identifier of the candidate selection event category."
                }
            }
        }
    ]
}

Nested Schema : MLString

Type: array

Show Source

• [0]: object MLStringItem

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/MLStringItem"
    }
}

Nested Schema : CandidateSelectionEventCategory-allOf[1]

Type: object

Show Source

• code: string
  Public identifier of the candidate selection event category.

{
    "properties":{
        "code":{
            "type":"string",
            "description":"Public identifier of the candidate selection event category."
        }
    }
}

Nested Schema : MLStringItem

Type: object

Show Source

• locale: string
  The locale.
• value: string
  The value in the locale.

{
    "type":"object",
    "properties":{
        "locale":{
            "description":"The locale.",
            "type":"string"
        },
        "value":{
            "description":" The value in the locale.",
            "type":"string"
        }
    }
}

Nested Schema : Message-allOf[1]

Type: object

Show Source

• bccText: string
• ccText: string
• comment: string
• dateSent: number(int64)
• deliveryTransport: object MessageDeliveryTransport
  email, fax
• fromText: string
• id: integer(int64)
• messageTemplate: object MessageTemplate
• toText: string

{
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "bccText":{
            "type":"string"
        },
        "ccText":{
            "type":"string"
        },
        "comment":{
            "type":"string"
        },
        "dateSent":{
            "type":"number",
            "format":"int64"
        },
        "fromText":{
            "type":"string"
        },
        "toText":{
            "type":"string"
        },
        "deliveryTransport":{
            "$ref":"#/definitions/MessageDeliveryTransport"
        },
        "messageTemplate":{
            "$ref":"#/definitions/MessageTemplate"
        }
    }
}

Nested Schema : MessageDeliveryTransport

Type: object

email, fax

Match All

Show Source

• object ResourceLookup
  Base entity type for all resource based lookup entities in this model.

{
    "type":"object",
    "description":"email, fax",
    "allOf":[
        {
            "$ref":"#/definitions/ResourceLookup"
        }
    ]
}

Nested Schema : MessageTemplate

Type: object

Match All

Show Source

• BaseMultilingualAdminEntity
  This class serves as a common ancestor for all multilingual, administrable entities.
• object MessageTemplate-allOf[1]

{
    "type":"object",
    "description":"",
    "allOf":[
        {
            "$ref":"#/definitions/BaseMultilingualAdminEntity"
        },
        {
            "properties":{
                "id":{
                    "type":"integer",
                    "format":"int64"
                },
                "subject":{
                    "$ref":"#/definitions/MLString"
                }
            }
        }
    ]
}

Nested Schema : BaseMultilingualAdminEntity

This class serves as a common ancestor for all multilingual, administrable entities.

Match All

Show Source

• object BaseAdminEntity
  The base class for all administrable entities.
• object BaseMultilingualAdminEntity-allOf[1]

{
    "description":"This class serves as a common ancestor for all multilingual, administrable entities.",
    "allOf":[
        {
            "$ref":"#/definitions/BaseAdminEntity"
        },
        {
            "properties":{
                "active":{
                    "type":"boolean",
                    "description":"Indicates if the given language is active (or usable)."
                },
                "base":{
                    "type":"boolean",
                    "description":"Indicates if the given language is the base language for this entity."
                }
            }
        }
    ]
}

Nested Schema : MessageTemplate-allOf[1]

Type: object

Show Source

• id: integer(int64)
• subject: array MLString

{
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64"
        },
        "subject":{
            "$ref":"#/definitions/MLString"
        }
    }
}

Nested Schema : BaseAdminEntity

Type: object

The base class for all administrable entities.

Show Source

• code: string
  A unique identifier providing a meaningful key.
• id: integer(int32)
  A unique internal identifier.
• name: string
  The name of the administration entity (mutlilingual).
• status: AdminEntityStatus
  The administration entity status. Possible values: 1 Active, 2 Draft.

{
    "type":"object",
    "description":"The base class for all administrable entities.",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int32",
            "description":"A unique internal identifier."
        },
        "code":{
            "type":"string",
            "description":"A unique identifier providing a meaningful key."
        },
        "name":{
            "type":"string",
            "description":"The name of the administration entity (mutlilingual)."
        },
        "status":{
            "$ref":"#/definitions/AdminEntityStatus"
        }
    }
}

Nested Schema : BaseMultilingualAdminEntity-allOf[1]

Type: object

Show Source

• active: boolean
  Indicates if the given language is active (or usable).
• base: boolean
  Indicates if the given language is the base language for this entity.

{
    "properties":{
        "active":{
            "type":"boolean",
            "description":"Indicates if the given language is active (or usable)."
        },
        "base":{
            "type":"boolean",
            "description":"Indicates if the given language is the base language for this entity."
        }
    }
}

Nested Schema : AdminEntityStatus

The administration entity status. Possible values: 1 Active, 2 Draft.

Match All

Show Source

• object ResourceLookup
  Base entity type for all resource based lookup entities in this model.
• object AdminEntityStatus-allOf[1]

{
    "description":"The administration entity status. Possible values: 1 Active, 2 Draft.",
    "allOf":[
        {
            "$ref":"#/definitions/ResourceLookup"
        },
        {
            "properties":{
                "code":{
                    "type":"string",
                    "description":"A unique alphanumeric code identifying a status."
                }
            }
        }
    ]
}

Nested Schema : AdminEntityStatus-allOf[1]

Type: object

Show Source

• code: string
  A unique alphanumeric code identifying a status.

{
    "properties":{
        "code":{
            "type":"string",
            "description":"A unique alphanumeric code identifying a status."
        }
    }
}

Nested Schema : ApplicationTrackingItemToken

Type: object

This class is use to store a pair of informations (token ,value) to help build the column details that is displayed into the column details. Suppose that we have a detail string that look like that : 'Hello {token_example} !!!' And suppose that we have a token 'token_example' who is value is 'World'. When the replacement will be done, we will have this detail string : Hello World !!!

Match All

Show Source

• object Entity
  Base entity type.
• object ApplicationTrackingItemToken-allOf[1]

{
    "type":"object",
    "description":"This class is use to store a pair of informations (token ,value) to help build the column details that is displayed into the column details. Suppose that we have a detail string that look like that : 'Hello {token_example} !!!' And suppose that we have a token 'token_example' who is value is 'World'. When the replacement will be done, we will have this detail string : Hello World !!!",
    "allOf":[
        {
            "$ref":"#/definitions/Entity"
        },
        {
            "properties":{
                "token":{
                    "type":"string",
                    "description":"The token is a string that we need to replace with it's value to build the detail string that will be displayed."
                },
                "value":{
                    "type":"string",
                    "description":"The value is string that will replace the token string to build the detail string that will be displayed."
                }
            }
        }
    ]
}

Nested Schema : ApplicationTrackingItemToken-allOf[1]

Type: object

Show Source

• token: string
  The token is a string that we need to replace with it's value to build the detail string that will be displayed.
• value: string
  The value is string that will replace the token string to build the detail string that will be displayed.

{
    "properties":{
        "token":{
            "type":"string",
            "description":"The token is a string that we need to replace with it's value to build the detail string that will be displayed."
        },
        "value":{
            "type":"string",
            "description":"The value is string that will replace the token string to build the detail string that will be displayed."
        }
    }
}

Response

204 Response

Successful operation.

405 Response

Invalid input.

Examples

curl -X POST -k -i 'https://mysite.example.com/enterprise/fluid/api/v1/applications/8157/comments' --data '{ "commentText":"Testing add comment1" }'

Example of Response Header

The following shows an example of the response header set to the newly created comment.

Status: HTTP/1.1 204 OK
https://mysite.example.com/enterprise/fluid/api/v1/applications/8157/comments/214933