Service Definition Response

Description

A service definition response contains sample responses for JSON and XML data formats.

NOTE:This object is available when API Packager is turned on for a customer. Please contact Support or your Account Manager if you have any questions about API Packager.

Object Fields

id

The id field is the primary identifier for the object.

type maxLength format default optional readonly createonly queryable sortable
integer no yes no yes no

format

XML or JSON

type maxLength format default optional readonly createonly queryable sortable
string 10 no no no yes no

definition

 

type maxLength format default optional readonly createonly queryable sortable
string yes no no yes no

created

The date that this object was created.

type maxLength format default optional readonly createonly queryable sortable
string 20 date-time yes yes no yes no

updated

The date this object was last updated.

type maxLength format default optional readonly createonly queryable sortable
string 20 date-time yes yes no yes no

object_type

The type of the object.

type maxLength format default optional readonly createonly queryable sortable
string 32 yes yes no no no

Relationships

Service Definition Method

A Service Definition Response has one and only one related Service Definition Method object. The related Service Definition Method object can be accessed directly via the object.query API method by including this relationship in the query, e.g. select *, service_definition_method from service_definition_responses.

Object Methods

The service_definition_response namespace contains the following methods for manipulating services.

service_definition_response.create
Create a response for a service definition method  .
service_definition_response.validate
Validate a service definition response  .
service_definition_response.update
Update a response for a service definition method  .
service_definition_response.delete
Delete a service definition response or a list of responses  .
service_definition_response.fetch
Get a specific service definition response or a list of service definition responses  .

Docs Navigation