Jump to

• Request
• Response
• Examples

List of Lead Notes

get

/appstore/publisher/v1/leads/{leadId}/notes

Get all notes for a lead.

Request

Path Parameters

• leadId: integer(int64)
  Unique identifier of lead for which notes have to be returned.

Query Parameters

• limit(optional): integer(int32)
  Limit tells how many records to return (starting from the offset). Limit should be greater than zero and less than or equal to 100 (default=30).
• offset(optional): integer(int32)
  Offset and limit together determine how many records to return from the collection. Offset is the starting index of the records to return, which should be greater than or equal to zero (default=0).

Back to Top

Response

Supported Media Types

• application/json;qs=1
• application/xml;qs=.5

200 Response

Successful Operation

Body ()

Root Schema : collection

Type: object

Show Source

• count(optional): integer(int32)
• hasMore(optional): boolean
  Default Value: false
• items(optional): array items
• links(optional): array link
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "xml":{
                "name":"items",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/LeadNote"
            }
        },
        "hasMore":{
            "type":"boolean",
            "default":false
        },
        "count":{
            "type":"integer",
            "format":"int32"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "links":{
            "type":"array",
            "xml":{
                "name":"link",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "xml":{
        "name":"collection"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object notes

{
    "type":"array",
    "xml":{
        "name":"items",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/LeadNote"
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "xml":{
        "name":"link",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : notes

Type: object

Show Source

• createdBy(optional): string
• creationTime(optional): string
• note(optional): string

{
    "type":"object",
    "properties":{
        "note":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "creationTime":{
            "type":"string"
        }
    },
    "xml":{
        "name":"notes"
    }
}

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• rel(optional): string
  Allowed Values: [ "SELF", "CANONICAL", "NEXT", "TEMPLATE", "PREV" ]

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "xml":{
                "attribute":true
            },
            "enum":[
                "SELF",
                "CANONICAL",
                "NEXT",
                "TEMPLATE",
                "PREV"
            ]
        },
        "href":{
            "type":"string",
            "xml":{
                "attribute":true
            }
        }
    }
}

400 Response

Invalid Parameter Value

401 Response

Not Authorized

404 Response

Entity Not Found

500 Response

System Error

Back to Top

Examples

The following example gets lead notes for a lead, by submitting a GET request on the REST resource using cURL.

cURL Example

curl -X GET -H "X-Oracle-UserId: partner-email" -H "Authorization: Bearer Access-token" "https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/leads/8006587/notes

Request Header

X-Oracle-UserId: [e-mail] 
Authorization: Bearer Access-token 

Request Body

None

HTTP Status Code:

200 OK

JSON Response:

{
   "items":[
      {
         "notes":{
            "note":"Contacted customer",
            "createdBy":"Appstore Admin",
            "creationTime":"2017-12-26T10:00:29.000Z"
         }
      }
   ],
   "hasMore":false,
   "count":1,
   "totalResults":1,
   "links":[
      {
         "rel":"CANONICAL",
         "href":"https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/leads/8006587/notes"
      },
      {
         "rel":"SELF",
         "href":"https://ocm-apis.cloud.oracle.com/appstore/publisher/v1/leads/8006587/notes"
      }
   ]
}

Back to Top