Get an answer
get
/services/rest/connect/v1.4/answers/{id}
Request
Path Parameters
-
id(required): integer
The unique identifier of the answer.
Response
Default Response
Root Schema : answers
Type:
objectThe knowledge base information that provides solutions to the common customer support questions.
Show Source
-
accessLevels:
object namedIDs-answers-accessLevels
The named ID that can be included in a list.
-
adminLastAccessTime:
[
"string",
"null"
]
The date and time when the answer was last accessed by an administrator. This attribute is read-only.
-
answerType:
object namedIDs-answerTypes
The type of an answer.
-
answerVersion:
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:
[
"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:
object answers-assignedTo
The collection of staff account and staff group.
-
banner:
object answers-banner
The display flags of a banner.
-
categories:
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:
object answers-commonAttachments
The file attachment shared by sibling answers.
-
createdTime:
string
The date and time when the answer was created. This attribute is read-only.
-
expiresDate:
[
"string",
"null"
]
The date when the answer expires and is set to review status.
-
fileAttachments:
object answers-fileAttachments
The file attachment shared by answers.
-
guidedAssistance:
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:
integer
Minimum Value:
1Maximum Value:9223372036854776000The unique identifier of the answer. -
keywords:
[
"string",
"null"
]
Maximum Length:
1333The list of space separated keywords associated with an answer. -
language:
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:
[
"string",
"null"
]
The date and time when the answer was last accessed. This attribute is read-only.
-
lastNotificationTime:
[
"string",
"null"
]
The date and time when the last notification was generated. This attribute is read-only.
-
lookupName:
string
Maximum Length:
255The name used to look up the answer. -
name:
string
Maximum Length:
20The string version of the answer ID, which is used as the reference number of the answer. This attribute is read-only. -
nextNotificationTime:
[
"string",
"null"
]
The date and time when the next earliest notification will be sent.
-
notes:
object answers-notes
The note text associated with the objects such as contacts and organizations.
-
originalReferenceNumber:
[
"string",
"null"
]
Maximum Length:
13Pattern:^[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:
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:
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:
[
"string",
"null"
]
The date when the answer will be published and made available to users.
-
question:
[
"string",
"null"
]
Maximum Length:
1048576The question or the description of the answer. - relatedAnswers: object answers-relatedAnswers
-
siblingAnswers:
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:
[
"string",
"null"
]
Maximum Length:
1048576The solution or the answer portion of the answer. -
specialResponse:
[
"string",
"null"
]
Maximum Length:
1048576The special response of the answer. -
statusWithType:
object answers-statusWithType
The status of an object with its associated status type.
-
summary:
string
Maximum Length:
240The title or short summary of the answer. -
updatedByAccount:
[
"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:
string
The date and time when the answer was last updated. This attribute is read-only.
-
uRL:
[
"string",
"null"
]
Maximum Length:
1333The URL which returns the answer, if the answer type is URL. -
versionDetail:
object answers-versionDetail
The details of the answer version.
Nested Schema : namedIDs-answers-accessLevels
Type:
objectThe named ID that can be included in a list.
Show Source
-
id:
integer
Minimum Value:
1Maximum Value:9223372036854776000The unique identifier of the access level. -
lookupName:
string
Maximum Length:
255The name used to look up the access level.
Nested Schema : namedIDs-answerTypes
Type:
objectThe type of an answer.
Show Source
-
id:
integer
Minimum Value:
1Maximum Value:9223372036854776000The unique identifier of the answer type. -
lookupName:
string
Maximum Length:
255The name used to look up the answer type.
Nested Schema : answerVersion
Type:
objectThe 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:
objectThe collection of staff account and staff group.
Show Source
-
account:
[
"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:
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.
Nested Schema : categories
Type:
arrayThe 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
Nested Schema : answers-commonAttachments
Type:
objectThe file attachment shared by sibling answers.
Show Source
-
contentType:
string
Maximum Length:
128Pattern:^[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:
string
The date and time when the file was associated with the answer. This attribute is read-only.
-
data:
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:
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:
string
Maximum Length:
100Pattern:^[^ \/:*?"<>|]*$The name of the file when saving it to the disk. -
formData:
string
-
id:
integer
Minimum Value:
1Maximum Value:9223372036854776000The unique identifier of the file attachment. -
names:
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:
boolean
Indicates whether the file attachment is hidden from the end users. This attribute does not have a default value.
-
size:
integer
Minimum Value:
1Maximum Value:2147483647The size of the file in bytes. This attribute is read-only. -
updatedTime:
[
"string",
"null"
]
The date and time when the file was last updated. This attribute is read-only.
-
uRL:
string
Maximum Length:
1333The URL to access this file.
Nested Schema : answers-fileAttachments
Type:
objectThe file attachment shared by answers.
Show Source
-
contentType:
string
Maximum Length:
128Pattern:^[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:
string
The date and time when the file was associated with the answer. This attribute is read-only.
-
data:
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:
string
Maximum Length:
1333The description for the contents of the file attachment. -
disabled:
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:
string
Maximum Length:
100Pattern:^[^ \/:*?"<>|]*$The name of the file when saving it to the disk. -
formData:
string
The HTML form which is used to upload file attachments.
-
id:
integer
Minimum Value:
1Maximum Value:9223372036854776000The unique identifier of the file attachment. -
indexed:
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:
string
Maximum Length:
40Pattern:^[^ ]*$The short display name of the file attachment. -
private:
boolean
Indicates whether the file attachment is hidden from the end users. The default value is false.
-
size:
integer
Minimum Value:
1Maximum Value:2147483647The size of the file in bytes. This attribute is read-only. -
updatedTime:
[
"string",
"null"
]
The date and time when the file was last updated. This attribute is read-only.
-
uRL:
string
Maximum Length:
1333The URL to access the file.
Nested Schema : namedIDs-answers-guidedAssistance
Type:
objectAn 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:
integer
Minimum Value:
0ID value -
lookupName:
string
Maximum Length:
255Name used to lookup this object
Nested Schema : namedIDs-answers-language
Type:
objectAn 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:
integer
Minimum Value:
0ID value -
lookupName:
string
Maximum Length:
255Name used to lookup this object
Nested Schema : answers-notes
Type:
objectThe note text associated with the objects such as contacts and organizations.
Show Source
-
channel:
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:
[
"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:
string
The date and time when the note was created. This attribute is read-only.
-
id:
integer
Minimum Value:
1Maximum Value:9223372036854776000The unique identifier of the note. -
text:
string
Maximum Length:
349525The text content in the note. -
updatedByAccount:
[
"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:
string
The date and time when the note was last updated. This attribute is read-only.
Nested Schema : namedIDs-answers-positionInList
Type:
objectAn 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:
integer
Minimum Value:
0ID value -
lookupName:
string
Maximum Length:
255Name used to lookup this object
Nested Schema : products
Type:
arrayThe 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
Nested Schema : siblingAnswers
Type:
arrayThe 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
Nested Schema : answers-statusWithType
Type:
objectThe status of an object with its associated status type.
Show Source
-
status:
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:
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.
Nested Schema : answers-versionDetail
Type:
objectThe details of the answer version.
Show Source
-
draftNote:
[
"string",
"null"
]
Maximum Length:
1333The draft note for the answer version. -
draftTime:
string
The date and time when the draft answer version was created.
-
publishedTime:
[
"string",
"null"
]
The date and time when the draft answer version was published.
-
publishNote:
[
"string",
"null"
]
Maximum Length:
1333The published note for the answer version. -
state:
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:
[
"string",
"null"
]
The date and time when the answer version was unpublished.
Nested Schema : namedIDs-answers-assignedTo-staffGroup
Type:
objectAn 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:
integer
Minimum Value:
0ID value -
lookupName:
string
Maximum Length:
255Name used to lookup this object
Nested Schema : items
Type:
objectNested Schema : answers-commonAttachments-names
Type:
objectThe 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:
string
Maximum Length:
80The language-specific label text. The value cannot be null or empty. -
language:
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.
Nested Schema : namedIDs-answers-commonAttachments-names-language
Type:
objectAn 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:
integer
Minimum Value:
0ID value -
lookupName:
string
Maximum Length:
255Name used to lookup this object
Nested Schema : namedIDs-answers-notes-channel
Type:
objectAn 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:
integer
Minimum Value:
0ID value -
lookupName:
string
Maximum Length:
255Name used to lookup this object
Nested Schema : items
Type:
objectNested Schema : items
Type:
objectNested Schema : namedIDs-answers-statusWithType-status
Type:
objectAn 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:
integer
Minimum Value:
0ID value -
lookupName:
string
Maximum Length:
255Name used to lookup this object
Nested Schema : namedIDs-answers-statusWithType-statusType
Type:
objectAn 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:
integer
Minimum Value:
0ID value -
lookupName:
string
Maximum Length:
255Name used to lookup this object
Nested Schema : namedIDs-answers-versionDetail-state
Type:
objectAn 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:
integer
Minimum Value:
0ID value -
lookupName:
string
Maximum Length:
255Name used to lookup this object
Examples
Use GET with the following syntax to retrieve data for an answer object:
https://your_site_interface/services/rest/connect/version/answers/answer_idRequest URI example
https://mysite.example.com/services/rest/connect/v1.4/answers/57Response 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"
}
]
}