Jump to

• Request
• Response
• Examples

Retrieve an event

get

/api/bulk/2.0/events/{id}

Retrieves an event for the event id provided.

Request

Supported Media Types

• application/json
• text/csv

Path Parameters

• id(required): integer
  The event's resource identification number.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK.

Body ()

Root Schema : EventIndividualResponse

Type: object

Title: EventIndividualResponse

The name of the event.

Show Source

• createdAt: string(date-time)
  Title: createdAt

  The date and time the entity was created, expressed using the ISO-8601 standard.
• createdBy: string
  Title: createdBy

  The login id of the user who created the entity.
• displayNameFieldUri: string
  Title: displayNameFieldUri

  The relative uri used to reference the event field that represents the display field, for this event.
• emailAddressFieldUri: string
  Title: emailAddressFieldUri

  The relative uri used to reference the event field that represents an email address, for this event.
• name: string
  Title: name

  The name of the event definition.
• uniqueFieldUri: string
  Title: uniqueFieldUri

  The relative uri used to reference the event field that has a uniqueness constraint on it, for this event.
• updatedAt: string(date-time)
  Title: updatedAt

  The date and time the entity was last updated, expressed using the ISO-8601 standard.
• updatedBy: string
  Title: updatedBy

  The login id of the user that last updated the entity.
• uri: string
  Title: uri

  System-generated unique resource identifier that defines the definition for future referencing.

{
    "title":"EventIndividualResponse",
    "description":"The name of the event.",
    "properties":{
        "createdAt":{
            "format":"date-time",
            "title":"createdAt",
            "description":"The date and time the entity was created, expressed using the ISO-8601 standard.",
            "type":"string"
        },
        "createdBy":{
            "title":"createdBy",
            "description":"The login id of the user who created the entity.",
            "type":"string"
        },
        "displayNameFieldUri":{
            "title":"displayNameFieldUri",
            "description":"The relative uri used to reference the event field that represents the display field, for this event.",
            "type":"string"
        },
        "emailAddressFieldUri":{
            "title":"emailAddressFieldUri",
            "description":"The relative uri used to reference the event field that represents an email address, for this event.",
            "type":"string"
        },
        "name":{
            "title":"name",
            "description":"The name of the event definition.",
            "type":"string"
        },
        "uniqueFieldUri":{
            "title":"uniqueFieldUri",
            "description":"The relative uri used to reference the event field that has a uniqueness constraint on it, for this event.",
            "type":"string"
        },
        "updatedAt":{
            "format":"date-time",
            "title":"updatedAt",
            "description":"The date and time the entity was last updated, expressed using the ISO-8601 standard.",
            "type":"string"
        },
        "updatedBy":{
            "title":"updatedBy",
            "description":"The login id of the user that last updated the entity.",
            "type":"string"
        },
        "uri":{
            "title":"uri",
            "description":"System-generated unique resource identifier that defines the definition for future referencing.",
            "type":"string"
        }
    }
}

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

409 Response

There was a conflict. See Status Codes for information about other possible HTTP status codes.

410 Response

The requested resource is no longer available. See Status Codes for information about other possible HTTP status codes.

412 Response

The resource you are attempting to delete has dependencies, and cannot be deleted. See Status Codes for information about other possible HTTP status codes.

413 Response

Storage space exceeded. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an internal server error. See Status Codes for information about other possible HTTP status codes.

503 Response

There was a timeout processing the request. See Status Codes for information about other possible HTTP status codes.

Back to Top

Examples

Retrieve the event with id #5:

GET /events/5
			

Response:

{
  "name": "Example Event",
  "displayNameFieldUri": "/events/5/fields/34",
  "emailAddressFieldUri": "/events/5/fields/34",
  "uniqueFieldUri": "/events/5/fields/34",
  "createdBy": "API.User",
  "createdAt": "2016-03-23T15:04:21.8400000Z",
  "updatedBy": "API.User",
  "updatedAt": "2016-05-30T18:00:46.9200000Z",
  "uri": "/events/5"
}
			

Back to Top