1. REST API for Oracle B2C Service
  2. Tasks
  3. Answer Versions

Get an answer version

get

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

Request

Path Parameters
Back to Top

Response

Default Response

Body ()
Root Schema : answerVersions
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.
Show Source
Nested Schema : namedIDs-answerVersions-accessLevels
Type: object
The named ID that can be included in a list.
Show Source
Nested Schema : answer
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 : namedIDs-answerVersions-answerType
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
Nested Schema : answerVersions-assignedTo
Type: object
The collection of staff account and staff group.
Show Source
Nested Schema : answerVersions-banner
Type: object
The display flags of a banner.
Show Source
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
Nested Schema : answerVersions-commonAttachments
Type: object
The file attachment shared by sibling answers.
Show Source
Nested Schema : answerVersions-fileAttachments
Type: object
The file attachment shared by answers.
Show Source
Nested Schema : namedIDs-answerVersions-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
Nested Schema : namedIDs-answerVersions-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
Nested Schema : answerVersions-notes
Type: object
The note text associated with the objects such as contacts and organizations.
Show Source
Nested Schema : namedIDs-answerVersions-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
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
Nested Schema : answerVersions-relatedAnswers
Type: object
The link to related answers.
Show Source
Nested Schema : answerVersions-statusWithType
Type: object
The status of an object with its associated status type.
Show Source
Nested Schema : answerVersions-versionDetail
Type: object
The details of the answer version.
Show Source
Nested Schema : namedIDs-answerVersions-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
Nested Schema : namedIDs-answerVersions-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
Nested Schema : items
Type: object
Nested Schema : answerVersions-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
Nested Schema : namedIDs-answerVersions-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
Nested Schema : namedIDs-answerVersions-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
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 : namedIDs-answerVersions-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
Nested Schema : namedIDs-answerVersions-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
Nested Schema : namedIDs-answerVersions-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
Back to Top

Examples

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

https://your_site_interface/services/rest/connect/version/answerVersions/answer_version_id

Request URI example

https://mysite.example.com/services/rest/connect/v1.4/answerVersions/1

Response body example

{
    "id": 1,
    "lookupName": "1",
    "createdTime": "2005-09-29T18:55:29.000Z",
    "updatedTime": "2010-03-24T06:03:03.000Z",
    "accessLevels": {
        "links": [
            {
                "rel": "self",
                "href": "http://mysite.example.com/services/rest/connect/v1.4/answerVersions/1/accessLevels"
            },
            {
                "rel": "full",
                "href": "http://mysite.example.com/services/rest/connect/v1.4/answerVersions/1/accessLevels/{accessLevel_id}",
                "templated": true
            }
        ]
    },
    "adminLastAccessTime": null,
    "answer": {
        "links": [
            {
                "rel": "self",
                "href": "http://mysite.example.com/services/rest/connect/v1.4/answers/1"
            },
            {
                "rel": "canonical",
                "href": "http://mysite.example.com/services/rest/connect/v1.4/answers/1"
            },
            {
                "rel": "describedby",
                "href": "http://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/answers",
                "mediaType": "application/schema+json"
            }
        ]
    },
    "answerType": {
        "id": 1,
        "lookupName": "HTML"
    },
    "assignedTo": {
        "account": {
            "links": [
                {
                    "rel": "self",
                    "href": "http://mysite.example.com/services/rest/connect/v1.4/accounts/4"
                },
                {
                    "rel": "canonical",
                    "href": "http://mysite.example.com/services/rest/connect/v1.4/accounts/4"
                },
                {
                    "rel": "describedby",
                    "href": "http://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/accounts",
                    "mediaType": "application/schema+json"
                }
            ]
        },
        "staffGroup": {
            "id": 100127,
            "lookupName": "Sales"
        }
    },
    "banner": {
        "importanceFlag": null,
        "text": null,
        "updatedByAccount": null,
        "updatedTime": null
    },
    "categories": {
        "links": [
            {
                "rel": "self",
                "href": "http://mysite.example.com/services/rest/connect/v1.4/answerVersions/1/categories"
            },
            {
                "rel": "full",
                "href": "http://mysite.example.com/services/rest/connect/v1.4/answerVersions/1/categories/{category_id}",
                "templated": true
            }
        ]
    },
    "commonAttachments": {
        "links": [
            {
                "rel": "self",
                "href": "http://mysite.example.com/services/rest/connect/v1.4/answerVersions/1/commonAttachments"
            },
            {
                "rel": "full",
                "href": "http://mysite.example.com/services/rest/connect/v1.4/answerVersions/1/commonAttachments/{commonAttachment_id}",
                "templated": true
            }
        ]
    },
    "customFields": {
        "CO": {
            "AnsBool": null,
            "AnsInteger": null,
            "AnsText": null,
            "Country": null,
            "ThingsToDo": null,
            "defect_id": null,
            "parent_a_id": null,
            "sibling_a_id": null
        },
        "c": {
            "bucket": null,
            "date1": null,
            "dttm1": null,
            "int1": null,
            "menu1": null,
            "textarea1": null,
            "yesno1": null,
            "url": null,
            "email": null,
            "phone": null
        }
    },
    "expiresDate": "2005-10-07",
    "fileAttachments": {
        "links": [
            {
                "rel": "self",
                "href": "http://mysite.example.com/services/rest/connect/v1.4/answerVersions/1/fileAttachments"
            },
            {
                "rel": "full",
                "href": "http://mysite.example.com/services/rest/connect/v1.4/answerVersions/1/fileAttachments/{fileAttachment_id}",
                "templated": true
            }
        ]
    },
    "guidedAssistance": null,
    "keywords": null,
    "language": {
        "id": 1,
        "lookupName": "en_US"
    },
    "lastAccessTime": "2012-03-03T00:56:28.000Z",
    "lastNotificationTime": null,
    "name": "1",
    "nextNotificationTime": null,
    "notes": {
        "links": [
            {
                "rel": "self",
                "href": "http://mysite.example.com/services/rest/connect/v1.4/answerVersions/1/notes"
            },
            {
                "rel": "full",
                "href": "http://mysite.example.com/services/rest/connect/v1.4/answerVersions/1/notes/{note_id}",
                "templated": true
            }
        ]
    },
    "originalReferenceNumber": "050923-000020",
    "positionInList": {
        "id": 1,
        "lookupName": "Historical Usefulness"
    },
    "products": {
        "links": [
            {
                "rel": "self",
                "href": "http://mysite.example.com/services/rest/connect/v1.4/answerVersions/1/products"
            },
            {
                "rel": "full",
                "href": "http://mysite.example.com/services/rest/connect/v1.4/answerVersions/1/products/{product_id}",
                "templated": true
            }
        ]
    },
    "publishOnDate": "2005-10-12",
    "question": "Interface: global\n\n",
    "relatedAnswers": {
        "links": [
            {
                "rel": "self",
                "href": "http://mysite.example.com/services/rest/connect/v1.4/answerVersions/1/relatedAnswers"
            },
            {
                "rel": "full",
                "href": "http://mysite.example.com/services/rest/connect/v1.4/answerVersions/1/relatedAnswers/{relatedAnswer_id}",
                "templated": true
            }
        ]
    },
    "solution": "To change your address, simply log onto the Global Wireless Customer area. Enter your wireless phone number and password to access your account. Click My Profile to change your personal information, including your address.",
    "statusWithType": {
        "status": {
            "id": 4,
            "lookupName": "Public"
        },
        "statusType": {
            "id": 4,
            "lookupName": "Public"
        }
    },
    "summary": "How do I change my address?",
    "updatedByAccount": {
        "links": [
            {
                "rel": "self",
                "href": "http://mysite.example.com/services/rest/connect/v1.4/accounts/2"
            },
            {
                "rel": "canonical",
                "href": "http://mysite.example.com/services/rest/connect/v1.4/accounts/2"
            },
            {
                "rel": "describedby",
                "href": "http://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/accounts",
                "mediaType": "application/schema+json"
            }
        ]
    },
    "uRL": null,
    "versionDetail": {
        "draftTime": "2005-09-29T18:55:29.000Z",
        "draftNote": null,
        "publishedTime": "2005-09-29T18:55:29.000Z",
        "publishNote": null,
        "state": {
            "id": 2,
            "lookupName": "Live"
        },
        "unpublishedTime": null
    },
    "links": [
        {
            "rel": "self",
            "href": "http://mysite.example.com/services/rest/connect/v1.4/answerVersions/1"
        },
        {
            "rel": "canonical",
            "href": "http://mysite.example.com/services/rest/connect/v1.4/answerVersions/1"
        },
        {
            "rel": "describedby",
            "href": "http://mysite.example.com/services/rest/connect/v1.4/metadata-catalog/answerVersions",
            "mediaType": "application/schema+json"
        }
    ]
}
Back to Top