Jump to

• Request
• Response
• Examples

Get an answer

get

/services/rest/connect/v1.4/answers/{id}

Request

Path Parameters

• id: integer
  The unique identifier of the answer.

Back to Top

Response

Default Response

Body ()

Root Schema : answers

Type: object

The knowledge base information that provides solutions to the common customer support questions.

Show Source

• accessLevels(optional): object namedIDs-answers-accessLevels
  The named ID that can be included in a list.
• adminLastAccessTime(optional): [ "string", "null" ]
  The date and time when the answer was last accessed by an administrator. This attribute is read-only.
• answerType(optional): object namedIDs-answerTypes
  The type of an answer.
• answerVersion(optional): object answerVersion
  The versioned instance of an answer. Answers are solutions to common customer support questions. These questions and answers are maintained in the Oracle B2C Service knowledge base. It is the reference to a resource in 'answerVersions' collection. Only ID or lookupName can be provided to specify the resource.
• assignedSibling(optional): [ "object", "null" ]
  The knowledge base information that provides solutions to the common customer support questions. It is the reference to a resource in 'answers' collection. Only ID or lookupName can be provided to specify the resource.
• assignedTo(optional): object answers-assignedTo
  The collection of staff account and staff group.
• banner(optional): object answers-banner
  The display flags of a banner.
• categories(optional): array categories
  The hierarchical service category that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceCategories' collection. Only ID or lookupName can be provided to specify the resources.
• commonAttachments(optional): object answers-commonAttachments
  The file attachment shared by sibling answers.
• createdTime(optional): string
  The date and time when the answer was created. This attribute is read-only.
• expiresDate(optional): [ "string", "null" ]
  The date when the answer expires and is set to review status.
• fileAttachments(optional): object answers-fileAttachments
  The file attachment shared by answers.
• guidedAssistance(optional): object namedIDs-answers-guidedAssistance
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• id(optional): integer
  Minimum Value: 1

  Maximum Value: 9.223372036854776E18

  The unique identifier of the answer.
• keywords(optional): [ "string", "null" ]
  Maximum Length: 1333

  The list of space separated keywords associated with an answer.
• language(optional): object namedIDs-answers-language
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• lastAccessTime(optional): [ "string", "null" ]
  The date and time when the answer was last accessed. This attribute is read-only.
• lastNotificationTime(optional): [ "string", "null" ]
  The date and time when the last notification was generated. This attribute is read-only.
• lookupName(optional): string
  Maximum Length: 255

  The name used to look up the answer.
• name(optional): string
  Maximum Length: 20

  The string version of the answer ID, which is used as the reference number of the answer. This attribute is read-only.
• nextNotificationTime(optional): [ "string", "null" ]
  The date and time when the next earliest notification will be sent.
• notes(optional): object answers-notes
  The note text associated with the objects such as contacts and organizations.
• originalReferenceNumber(optional): [ "string", "null" ]
  Maximum Length: 13

  Pattern: ^[0-9]{2}[0|1][0-9][0-3][0-9]\-[0-9]{6}$

  The reference number of the incident that was proposed to create this answer. The reference number is common for all the sibling answers.
• positionInList(optional): object namedIDs-answers-positionInList
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• products(optional): array products
  The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceProducts' collection. Only ID or lookupName can be provided to specify the resources.
• publishOnDate(optional): [ "string", "null" ]
  The date when the answer will be published and made available to users.
• question(optional): [ "string", "null" ]
  Maximum Length: 1048576

  The question or the description of the answer.
• relatedAnswers(optional): object answers-relatedAnswers
  The link to related answers.
• siblingAnswers(optional): array siblingAnswers
  The knowledge base information that provides solutions to the common customer support questions. It is the reference to a resource in 'answers' collection. Only ID or lookupName can be provided to specify the resources.
• solution(optional): [ "string", "null" ]
  Maximum Length: 1048576

  The solution or the answer portion of the answer.
• specialResponse(optional): [ "string", "null" ]
  Maximum Length: 1048576

  The special response of the answer.
• statusWithType(optional): object answers-statusWithType
  The status of an object with its associated status type.
• summary(optional): string
  Maximum Length: 240

  The title or short summary of the answer.
• updatedByAccount(optional): [ "object", "null" ]
  The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
• updatedTime(optional): string
  The date and time when the answer was last updated. This attribute is read-only.
• uRL(optional): [ "string", "null" ]
  Maximum Length: 1333

  The URL which returns the answer, if the answer type is URL.
• versionDetail(optional): object answers-versionDetail
  The details of the answer version.

{
    "type":"object",
    "description":"The knowledge base information that provides solutions to the common customer support questions.",
    "properties":{
        "specialResponse":{
            "type":[
                "string",
                "null"
            ],
            "description":"The special response of the answer.",
            "maxLength":1048576
        },
        "expiresDate":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date when the answer expires and is set to review status."
        },
        "accessLevels":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of access levels, which determine the end users that can view the answer.",
            "$ref":"#/definitions/namedIDs-answers-accessLevels"
        },
        "assignedSibling":{
            "type":[
                "object",
                "null"
            ],
            "description":"The knowledge base information that provides solutions to the common customer support questions. It is the reference to a resource in 'answers' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "originalReferenceNumber":{
            "pattern":"^[0-9]{2}[0|1][0-9][0-3][0-9]\\-[0-9]{6}$",
            "type":[
                "string",
                "null"
            ],
            "description":"The reference number of the incident that was proposed to create this answer. The reference number is common for all the sibling answers.",
            "maxLength":13
        },
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"The unique identifier of the answer.",
            "maximum":9.223372036854776E18
        },
        "commonAttachments":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The file attachments common to all sibling answers.",
            "$ref":"#/definitions/answers-commonAttachments"
        },
        "answerVersion":{
            "type":"object",
            "description":"The versioned instance of an answer. Answers are solutions to common customer support questions. These questions and answers are maintained in the Oracle B2C Service knowledge base. It is the reference to a resource in 'answerVersions' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "relatedAnswers":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The related answers linked to this answer.",
            "$ref":"#/definitions/answers-relatedAnswers"
        },
        "versionDetail":{
            "type":"object",
            "description":"The version of the draft note.",
            "$ref":"#/definitions/answers-versionDetail"
        },
        "question":{
            "type":[
                "string",
                "null"
            ],
            "description":"The question or the description of the answer.",
            "maxLength":1048576
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the answer.",
            "maxLength":255
        },
        "fileAttachments":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of file attachments.",
            "$ref":"#/definitions/answers-fileAttachments"
        },
        "assignedTo":{
            "type":"object",
            "description":"The staff member or group assigned to the answer.",
            "$ref":"#/definitions/answers-assignedTo"
        },
        "statusWithType":{
            "type":"object",
            "description":"The current status.",
            "$ref":"#/definitions/answers-statusWithType"
        },
        "lastNotificationTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date and time when the last notification was generated. This attribute is read-only."
        },
        "adminLastAccessTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date and time when the answer was last accessed by an administrator. This attribute is read-only."
        },
        "guidedAssistance":{
            "type":[
                "object",
                "null"
            ],
            "description":"The Guided Assistance guide.",
            "$ref":"#/definitions/namedIDs-answers-guidedAssistance"
        },
        "lastAccessTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date and time when the answer was last accessed. This attribute is read-only."
        },
        "language":{
            "type":"object",
            "description":"The language used for the answer text.",
            "$ref":"#/definitions/namedIDs-answers-language"
        },
        "answerType":{
            "type":"object",
            "description":"The type of storage for answer information.",
            "$ref":"#/definitions/namedIDs-answerTypes"
        },
        "banner":{
            "type":[
                "object",
                "null"
            ],
            "description":"The display flags of a banner.",
            "$ref":"#/definitions/answers-banner"
        },
        "categories":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The hierarchical service category that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceCategories' collection. Only ID or lookupName can be provided to specify the resources."
        },
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the answer was last updated. This attribute is read-only."
        },
        "name":{
            "type":"string",
            "description":"The string version of the answer ID, which is used as the reference number of the answer. This attribute is read-only.",
            "maxLength":20
        },
        "positionInList":{
            "type":"object",
            "description":"This attribute is used to initialize and/or force this answer to a particular ranking in the search results.",
            "$ref":"#/definitions/namedIDs-answers-positionInList"
        },
        "updatedByAccount":{
            "type":[
                "object",
                "null"
            ],
            "description":"The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "uRL":{
            "type":[
                "string",
                "null"
            ],
            "description":"The URL which returns the answer, if the answer type is URL.",
            "maxLength":1333
        },
        "notes":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The list of discussion threads.",
            "$ref":"#/definitions/answers-notes"
        },
        "solution":{
            "type":[
                "string",
                "null"
            ],
            "description":"The solution or the answer portion of the answer.",
            "maxLength":1048576
        },
        "summary":{
            "type":"string",
            "description":"The title or short summary of the answer.",
            "maxLength":240
        },
        "products":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceProducts' collection. Only ID or lookupName can be provided to specify the resources."
        },
        "keywords":{
            "type":[
                "string",
                "null"
            ],
            "description":"The list of space separated keywords associated with an answer.",
            "maxLength":1333
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the answer was created. This attribute is read-only."
        },
        "siblingAnswers":{
            "items":{
                "type":"object"
            },
            "type":[
                "array",
                "null"
            ],
            "description":"The knowledge base information that provides solutions to the common customer support questions. It is the reference to a resource in 'answers' collection. Only ID or lookupName can be provided to specify the resources."
        },
        "publishOnDate":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date when the answer will be published and made available to users."
        },
        "nextNotificationTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date and time when the next earliest notification will be sent."
        }
    }
}

Nested Schema : namedIDs-answers-accessLevels

Type: object

The named ID that can be included in a list.

Show Source

• id(optional): integer
  Minimum Value: 1

  Maximum Value: 9.223372036854776E18

  The unique identifier of the access level.
• lookupName(optional): string
  Maximum Length: 255

  The name used to look up the access level.

{
    "type":"object",
    "description":"The named ID that can be included in a list.",
    "properties":{
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"The unique identifier of the access level.",
            "maximum":9.223372036854776E18
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the access level.",
            "maxLength":255
        }
    }
}

Nested Schema : namedIDs-answerTypes

Type: object

The type of an answer.

Show Source

• id(optional): integer
  Minimum Value: 1

  Maximum Value: 9.223372036854776E18

  The unique identifier of the answer type.
• lookupName(optional): string
  Maximum Length: 255

  The name used to look up the answer type.

{
    "type":"object",
    "description":"The type of an answer.",
    "properties":{
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"The unique identifier of the answer type.",
            "maximum":9.223372036854776E18
        },
        "lookupName":{
            "type":"string",
            "description":"The name used to look up the answer type.",
            "maxLength":255
        }
    }
}

Nested Schema : answerVersion

Type: object

The versioned instance of an answer. Answers are solutions to common customer support questions. These questions and answers are maintained in the Oracle B2C Service knowledge base. It is the reference to a resource in 'answerVersions' collection. Only ID or lookupName can be provided to specify the resource.

Nested Schema : answers-assignedTo

Type: object

The collection of staff account and staff group.

Show Source

• account(optional): [ "object", "null" ]
  The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
• staffGroup(optional): object namedIDs-answers-assignedTo-staffGroup
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

{
    "type":"object",
    "description":"The collection of staff account and staff group.",
    "properties":{
        "staffGroup":{
            "type":[
                "object",
                "null"
            ],
            "description":"The staff group. The caller should assign the staff group when assigning to an account.",
            "$ref":"#/definitions/namedIDs-answers-assignedTo-staffGroup"
        },
        "account":{
            "type":[
                "object",
                "null"
            ],
            "description":"The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource."
        }
    }
}

Nested Schema : answers-banner

Type: object

The display flags of a banner.

Show Source

• importanceFlag(optional): object namedIDs-answers-banner-importanceFlag
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• text(optional): [ "string", "null" ]
  Maximum Length: 1333

  The description of a flag.
• updatedByAccount(optional): [ "object", "null" ]
  The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
• updatedTime(optional): [ "string", "null" ]
  The date and time when the banner was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The display flags of a banner.",
    "properties":{
        "text":{
            "type":[
                "string",
                "null"
            ],
            "description":"The description of a flag.",
            "maxLength":1333
        },
        "updatedByAccount":{
            "type":[
                "object",
                "null"
            ],
            "description":"The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "importanceFlag":{
            "type":[
                "object",
                "null"
            ],
            "description":"The importance of the banner.",
            "$ref":"#/definitions/namedIDs-answers-banner-importanceFlag"
        },
        "updatedTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date and time when the banner was last updated. This attribute is read-only."
        }
    }
}

Nested Schema : categories

Type: array

The hierarchical service category that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceCategories' collection. Only ID or lookupName can be provided to specify the resources.

Show Source

• Array of: object items

{
    "items":{
        "type":"object"
    },
    "type":[
        "array",
        "null"
    ],
    "description":"The hierarchical service category that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceCategories' collection. Only ID or lookupName can be provided to specify the resources."
}

Nested Schema : answers-commonAttachments

Type: object

The file attachment shared by sibling answers.

Show Source

• contentType(optional): string
  Maximum Length: 128

  Pattern: ^[a-zA-Z-]+/[-a-zA-Z0-9.+_*]+$

  The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on.
• createdTime(optional): string
  The date and time when the file was associated with the answer. This attribute is read-only.
• data(optional): string
  The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
• disabled(optional): boolean
  Indicates whether the file attachment is hidden when the associated answer is viewed. If the Private flag is not set, this flag hides the file attachment. This attribute does not have a default value.
• fileName(optional): string
  Maximum Length: 100

  Pattern: ^[^ \/:*?"<>|]*$

  The name of the file when saving it to the disk.
• formData(optional): string
• id(optional): integer
  Minimum Value: 1

  Maximum Value: 9.223372036854776E18

  The unique identifier of the file attachment.
• names(optional): object answers-commonAttachments-names
  The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.
• private(optional): boolean
  Indicates whether the file attachment is hidden from the end users. This attribute does not have a default value.
• size(optional): integer
  Minimum Value: 1

  Maximum Value: 2147483647

  The size of the file in bytes. This attribute is read-only.
• updatedTime(optional): [ "string", "null" ]
  The date and time when the file was last updated. This attribute is read-only.
• uRL(optional): string
  Maximum Length: 1333

  The URL to access this file.

{
    "type":"object",
    "description":"The file attachment shared by sibling answers.",
    "properties":{
        "updatedTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date and time when the file was last updated. This attribute is read-only."
        },
        "contentType":{
            "pattern":"^[a-zA-Z-]+/[-a-zA-Z0-9.+_*]+$",
            "type":"string",
            "description":"The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on.",
            "maxLength":128
        },
        "uRL":{
            "type":"string",
            "description":"The URL to access this file.",
            "maxLength":1333
        },
        "formData":{
            "type":"string",
            "description":""
        },
        "private":{
            "type":"boolean",
            "description":"Indicates whether the file attachment is hidden from the end users. This attribute does not have a default value."
        },
        "fileName":{
            "pattern":"^[^\t\n\\/:*?\"<>|]*$",
            "type":"string",
            "description":"The name of the file when saving it to the disk.",
            "maxLength":100
        },
        "disabled":{
            "type":"boolean",
            "description":"Indicates whether the file attachment is hidden when the associated answer is viewed. If the Private flag is not set, this flag hides the file attachment. This attribute does not have a default value."
        },
        "names":{
            "items":{
                "type":"object"
            },
            "type":"array",
            "description":"The list of language specific display names.",
            "$ref":"#/definitions/answers-commonAttachments-names"
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the file was associated with the answer. This attribute is read-only."
        },
        "data":{
            "type":"string",
            "description":"The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field."
        },
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"The unique identifier of the file attachment.",
            "maximum":9.223372036854776E18
        },
        "size":{
            "minimum":1,
            "type":"integer",
            "description":"The size of the file in bytes. This attribute is read-only.",
            "maximum":2147483647
        }
    }
}

Nested Schema : answers-fileAttachments

Type: object

The file attachment shared by answers.

Show Source

• contentType(optional): string
  Maximum Length: 128

  Pattern: ^[a-zA-Z-]+/[-a-zA-Z0-9.+_*]+$

  The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on.
• createdTime(optional): string
  The date and time when the file was associated with the answer. This attribute is read-only.
• data(optional): string
  The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field.
• description(optional): string
  Maximum Length: 1333

  The description for the contents of the file attachment.
• disabled(optional): boolean
  Indicates whether the file attachment should be hidden when the associated answer is viewed. If the Private flag is not set, this flag hides the file attachment. This attribute does not have a default value.
• fileName(optional): string
  Maximum Length: 100

  Pattern: ^[^ \/:*?"<>|]*$

  The name of the file when saving it to the disk.
• formData(optional): string
  The HTML form which is used to upload file attachments.
• id(optional): integer
  Minimum Value: 1

  Maximum Value: 9.223372036854776E18

  The unique identifier of the file attachment.
• indexed(optional): boolean
  Indicates whether the file attachment's contents are included in the keyword indexing of the answer. This attribute does not have a default value.
• name(optional): string
  Maximum Length: 40

  Pattern: ^[^ ]*$

  The short display name of the file attachment.
• private(optional): boolean
  Indicates whether the file attachment is hidden from the end users. The default value is false.
• size(optional): integer
  Minimum Value: 1

  Maximum Value: 2147483647

  The size of the file in bytes. This attribute is read-only.
• updatedTime(optional): [ "string", "null" ]
  The date and time when the file was last updated. This attribute is read-only.
• uRL(optional): string
  Maximum Length: 1333

  The URL to access the file.

{
    "type":"object",
    "description":"The file attachment shared by answers.",
    "properties":{
        "updatedTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date and time when the file was last updated. This attribute is read-only."
        },
        "contentType":{
            "pattern":"^[a-zA-Z-]+/[-a-zA-Z0-9.+_*]+$",
            "type":"string",
            "description":"The MIME content type of the file. For example, text/plain, audio/mp3, image/jpg, and so on.",
            "maxLength":128
        },
        "name":{
            "pattern":"^[^\t\n]*$",
            "type":"string",
            "description":"The short display name of the file attachment.",
            "maxLength":40
        },
        "uRL":{
            "type":"string",
            "description":"The URL to access the file.",
            "maxLength":1333
        },
        "formData":{
            "type":"string",
            "description":"The HTML form which is used to upload file attachments."
        },
        "description":{
            "type":"string",
            "description":"The description for the contents of the file attachment.",
            "maxLength":1333
        },
        "private":{
            "type":"boolean",
            "description":"Indicates whether the file attachment is hidden from the end users. The default value is false."
        },
        "fileName":{
            "pattern":"^[^\t\n\\/:*?\"<>|]*$",
            "type":"string",
            "description":"The name of the file when saving it to the disk.",
            "maxLength":100
        },
        "disabled":{
            "type":"boolean",
            "description":"Indicates whether the file attachment should be hidden when the associated answer is viewed. If the Private flag is not set, this flag hides the file attachment. This attribute does not have a default value."
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the file was associated with the answer. This attribute is read-only."
        },
        "indexed":{
            "type":"boolean",
            "description":"Indicates whether the file attachment's contents are included in the keyword indexing of the answer. This attribute does not have a default value."
        },
        "data":{
            "type":"string",
            "description":"The Base64 encoded data contained in the file. The maximum supported length is defined by the maximum number of bytes allowed by this field."
        },
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"The unique identifier of the file attachment.",
            "maximum":9.223372036854776E18
        },
        "size":{
            "minimum":1,
            "type":"integer",
            "description":"The size of the file in bytes. This attribute is read-only.",
            "maximum":2147483647
        }
    }
}

Nested Schema : namedIDs-answers-guidedAssistance

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id(optional): integer
  Minimum Value: 0

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Nested Schema : namedIDs-answers-language

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id(optional): integer
  Minimum Value: 0

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Nested Schema : answers-notes

Type: object

The note text associated with the objects such as contacts and organizations.

Show Source

• channel(optional): object namedIDs-answers-notes-channel
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• createdByAccount(optional): [ "object", "null" ]
  The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
• createdTime(optional): string
  The date and time when the note was created. This attribute is read-only.
• id(optional): integer
  Minimum Value: 1

  Maximum Value: 9.223372036854776E18

  The unique identifier of the note.
• text(optional): string
  Maximum Length: 349525

  The text content in the note.
• updatedByAccount(optional): [ "object", "null" ]
  The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource.
• updatedTime(optional): string
  The date and time when the note was last updated. This attribute is read-only.

{
    "type":"object",
    "description":"The note text associated with the objects such as contacts and organizations.",
    "properties":{
        "updatedTime":{
            "type":"string",
            "description":"The date and time when the note was last updated. This attribute is read-only."
        },
        "updatedByAccount":{
            "type":[
                "object",
                "null"
            ],
            "description":"The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "text":{
            "type":"string",
            "description":"The text content in the note.",
            "maxLength":349525
        },
        "createdTime":{
            "type":"string",
            "description":"The date and time when the note was created. This attribute is read-only."
        },
        "createdByAccount":{
            "type":[
                "object",
                "null"
            ],
            "description":"The account represents a staff member in Oracle B2C Service. Examples of staff members are customer sales representatives, sales agents, site administrators, and so on. It is the reference to a resource in 'accounts' collection. Only ID or lookupName can be provided to specify the resource."
        },
        "id":{
            "minimum":1,
            "type":"integer",
            "description":"The unique identifier of the note.",
            "maximum":9.223372036854776E18
        },
        "channel":{
            "type":[
                "object",
                "null"
            ],
            "description":"The channel through which the note was created.",
            "$ref":"#/definitions/namedIDs-answers-notes-channel"
        }
    }
}

Nested Schema : namedIDs-answers-positionInList

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id(optional): integer
  Minimum Value: 0

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Nested Schema : products

Type: array

The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceProducts' collection. Only ID or lookupName can be provided to specify the resources.

Show Source

• Array of: object items

{
    "items":{
        "type":"object"
    },
    "type":[
        "array",
        "null"
    ],
    "description":"The hierarchical service product that provides an option to group answers and incidents for better organization and refined searching in the knowledge base. It is the reference to a resource in 'serviceProducts' collection. Only ID or lookupName can be provided to specify the resources."
}

Nested Schema : answers-relatedAnswers

Type: object

The link to related answers.

Show Source

• learnedStrength(optional): integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The relative relatedness of the linked answers.
• manualStrength(optional): [ "integer", "null" ]
  Minimum Value: 0

  Maximum Value: 2147483647

  The static strength of the link.
• similarityStrength(optional): integer
  Minimum Value: 0

  Maximum Value: 2147483647

  The strength of the link calculated by the link-clustering algorithms based on the content similarity of the answers.
• toAnswer(optional): object toAnswer
  The knowledge base information that provides solutions to the common customer support questions. It is the reference to a resource in 'answers' collection. Only ID or lookupName can be provided to specify the resource.

{
    "type":"object",
    "description":"The link to related answers.",
    "properties":{
        "learnedStrength":{
            "minimum":0,
            "type":"integer",
            "description":"The relative relatedness of the linked answers.",
            "maximum":2147483647
        },
        "manualStrength":{
            "minimum":0,
            "type":[
                "integer",
                "null"
            ],
            "description":"The static strength of the link.",
            "maximum":2147483647
        },
        "similarityStrength":{
            "minimum":0,
            "type":"integer",
            "description":"The strength of the link calculated by the link-clustering algorithms based on the content similarity of the answers.",
            "maximum":2147483647
        },
        "toAnswer":{
            "type":"object",
            "description":"The knowledge base information that provides solutions to the common customer support questions. It is the reference to a resource in 'answers' collection. Only ID or lookupName can be provided to specify the resource."
        }
    }
}

Nested Schema : siblingAnswers

Type: array

The knowledge base information that provides solutions to the common customer support questions. It is the reference to a resource in 'answers' collection. Only ID or lookupName can be provided to specify the resources.

Show Source

• Array of: object items

{
    "items":{
        "type":"object"
    },
    "type":[
        "array",
        "null"
    ],
    "description":"The knowledge base information that provides solutions to the common customer support questions. It is the reference to a resource in 'answers' collection. Only ID or lookupName can be provided to specify the resources."
}

Nested Schema : answers-statusWithType

Type: object

The status of an object with its associated status type.

Show Source

• status(optional): object namedIDs-answers-statusWithType-status
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• statusType(optional): object namedIDs-answers-statusWithType-statusType
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

{
    "type":"object",
    "description":"The status of an object with its associated status type.",
    "properties":{
        "status":{
            "type":"object",
            "description":"The current status.",
            "$ref":"#/definitions/namedIDs-answers-statusWithType-status"
        },
        "statusType":{
            "type":"object",
            "description":"The associated status type. This attribute is read-only.",
            "$ref":"#/definitions/namedIDs-answers-statusWithType-statusType"
        }
    }
}

Nested Schema : answers-versionDetail

Type: object

The details of the answer version.

Show Source

• draftNote(optional): [ "string", "null" ]
  Maximum Length: 1333

  The draft note for the answer version.
• draftTime(optional): string
  The date and time when the draft answer version was created.
• publishedTime(optional): [ "string", "null" ]
  The date and time when the draft answer version was published.
• publishNote(optional): [ "string", "null" ]
  Maximum Length: 1333

  The published note for the answer version.
• state(optional): object namedIDs-answers-versionDetail-state
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.
• unpublishedTime(optional): [ "string", "null" ]
  The date and time when the answer version was unpublished.

{
    "type":"object",
    "description":"The details of the answer version.",
    "properties":{
        "publishNote":{
            "type":[
                "string",
                "null"
            ],
            "description":"The published note for the answer version.",
            "maxLength":1333
        },
        "publishedTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date and time when the draft answer version was published."
        },
        "draftTime":{
            "type":"string",
            "description":"The date and time when the draft answer version was created."
        },
        "unpublishedTime":{
            "type":[
                "string",
                "null"
            ],
            "description":"The date and time when the answer version was unpublished."
        },
        "state":{
            "type":"object",
            "description":"The state of the version.",
            "$ref":"#/definitions/namedIDs-answers-versionDetail-state"
        },
        "draftNote":{
            "type":[
                "string",
                "null"
            ],
            "description":"The draft note for the answer version.",
            "maxLength":1333
        }
    }
}

Nested Schema : namedIDs-answers-assignedTo-staffGroup

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id(optional): integer
  Minimum Value: 0

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Nested Schema : namedIDs-answers-banner-importanceFlag

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id(optional): integer
  Minimum Value: 0

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Nested Schema : items

Type: object

Nested Schema : answers-commonAttachments-names

Type: object

The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.

Show Source

• labelText(optional): string
  Maximum Length: 80

  The language-specific label text. The value cannot be null or empty.
• language(optional): object namedIDs-answers-commonAttachments-names-language
  An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

{
    "type":"object",
    "description":"The language-specific strings used for localization of fields. The label text cannot be empty or null. The labels are assembled in a list associated with a particular text field.",
    "properties":{
        "labelText":{
            "type":"string",
            "description":"The language-specific label text. The value cannot be null or empty.",
            "maxLength":80
        },
        "language":{
            "type":"object",
            "description":"The ID of the language. This is the key for the list entry.",
            "$ref":"#/definitions/namedIDs-answers-commonAttachments-names-language"
        }
    }
}

Nested Schema : namedIDs-answers-commonAttachments-names-language

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id(optional): integer
  Minimum Value: 0

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Nested Schema : namedIDs-answers-notes-channel

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id(optional): integer
  Minimum Value: 0

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Nested Schema : items

Type: object

Nested Schema : toAnswer

Type: object

The knowledge base information that provides solutions to the common customer support questions. It is the reference to a resource in 'answers' collection. Only ID or lookupName can be provided to specify the resource.

Nested Schema : items

Type: object

Nested Schema : namedIDs-answers-statusWithType-status

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id(optional): integer
  Minimum Value: 0

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Nested Schema : namedIDs-answers-statusWithType-statusType

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id(optional): integer
  Minimum Value: 0

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Nested Schema : namedIDs-answers-versionDetail-state

Type: object

An ID which has an associated name string. These IDs can be set by either value or name. If the name cannot uniquely determine the value, an error is generated.

Show Source

• id(optional): integer
  Minimum Value: 0

  ID value
• lookupName(optional): string
  Maximum Length: 255

  Name used to lookup this object

{
    "type":"object",
    "description":"An ID which has an associated name string.  These IDs can be set by either value or name.  If the name cannot uniquely determine the value, an error is generated.",
    "properties":{
        "id":{
            "minimum":0,
            "type":"integer",
            "description":"ID value"
        },
        "lookupName":{
            "type":"string",
            "description":"Name used to lookup this object",
            "maxLength":255
        }
    }
}

Back to Top

Examples

Use GET with the following syntax to retrieve data for an answer object:

https://your_site_interface/services/rest/connect/version/answers/answer_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/answers/57

Response body example

{
    "id": 57,
    "lookupName": "57",
    "createdTime": "2016-01-29T19:35:41.000Z",
    "updatedTime": "2016-01-29T19:35:41.000Z",
    "accessLevels": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/answers/57/accessLevels"
            }
        ]
    },
    "adminLastAccessTime": "2016-01-29T19:35:41.000Z",
    "answerType": {
        "id": 1,
        "lookupName": "HTML"
    },
    "assignedTo": {
        "account": null,
        "staffGroup": null
    },
    "banner": {
        "importanceFlag": null,
        "text": null,
        "updatedByAccount": null,
        "updatedTime": null
    },
    "categories": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/answers/57/categories"
            }
        ]
    },
    "commonAttachments": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/answers/57/commonAttachments"
            }
        ]
    },
    "customFields": {
        "c": {}
    },
    "expiresDate": null,
    "fileAttachments": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/answers/57/fileAttachments"
            }
        ]
    },
    "guidedAssistance": null,
    "keywords": null,
    "language": {
        "id": 1,
        "lookupName": "en_US"
    },
    "lastAccessTime": "2016-01-29T19:35:41.000Z",
    "lastNotificationTime": null,
    "name": "57",
    "nextNotificationTime": null,
    "notes": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/answers/57/notes"
            }
        ]
    },
    "originalReferenceNumber": null,
    "positionInList": {
        "id": 1,
        "lookupName": "Historical Usefulness"
    },
    "products": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/answers/57/products"
            }
        ]
    },
    "publishOnDate": null,
    "question": null,
    "relatedAnswers": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/answers/57/relatedAnswers"
            }
        ]
    },
    "siblingAnswers": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/answers/57/siblingAnswers"
            }
        ]
    },
    "solution": "The FishPhone is water resistant to 10 meters, or 33 feet.",
    "statusWithType": {
        "status": {
            "id": 5,
            "lookupName": "Private"
        },
        "statusType": {
            "id": 5,
            "lookupName": "Private"
        }
    },
    "summary": "How deep can I get my FishPhone?",
    "updatedByAccount": {
        "links": [
            {
                "rel": "self",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/7"
            },
            {
                "rel": "canonical",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/accounts/7"
            },
            {
                "rel": "describedby",
                "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/accounts",
                "mediaType": "application/schema+json"
            }
        ]
    },
    "uRL": null,
    "links": [
        {
            "rel": "self",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/answers/57"
        },
        {
            "rel": "canonical",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/answers/57"
        },
        {
            "rel": "describedby",
            "href": "https://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/answers",
            "mediaType": "application/schema+json"
        }
    ]
}

Back to Top