Package com.postman.collection

package com.postman.collection

Encapsulates a Postman JSON collection and emulates functionality of the Postman SDK.

Collection JSON format v2.1.0 overview.

JPostman README

Related Packages

Package	Description
com.postman.collection.adapter

Class	Description
BodyElement	Encapsulates the body property of a Request object.
Collection	Encapsulates a Postman collection
CollectionElement	Abstract Base Class for all objects which are part of a collection
CollectionNotFoundException	Thrown when a collection is not found in Postman, or if a 404 is thrown attempting to retrieve a collection from Postman by URI
Cookie	Encapsulates the cookie property of a Postman Collection.
DuplicateVariableKeyException	Exception thrown when an attempt is made to add a Property to a PropertyList with a duplicate key
enumAuthType	Enumerates valid values for the type property of the auth element of a collection or request.
enumEventType	Enumerates the valid values for the listen property of an Event element.
enumHTTPRequestMethod	Enumerates valid HTTP methods, e.g, for the method property of a RequestBody element
enumItemType	Enumerates the two types of objects that can serve as an element in a collections item array.
enumRawBodyLanguage	Enumerates valid values for the value of the options/raw/language property of a RequestBody object when that body's mode property is set to raw
enumRequestBodyMode	Enumeration listing the possible values for the name of the property containing body data in a Request
enumVariableResolution	Enumeration listing variable resolution strategies
Event	Encapsulates members of the event array object.
Folder	Convenience class for the concept of a Folder in a Postman Collection.
IllegalPropertyAccessException	Exception thrown when an invalid action is taken against PropertyList, eg., IndexOutOfBounds, attempts to set the raw property of a BodyElement when that body's mode is not raw etc.
InvalidCollectionActionException	Exception thrown when an invalid action is attempted on a collection, eg.
InvalidPropertyException	Exception thrown when an invalid action is taken against an object property, eg., an attempt to see an Event's exec property to null, etc.
Item	Encapsulates the item object in the postman schema
ItemGroup	Abstract class encapsulating a Postman ItemGroup.
PostmanID	Convenience class to enable TypeSafe references to Postman UUIDs.
Property	Postman SDK analog: Not directly related, but probably close to PropertyBase
PropertyList<T>	Postman SDK analog: PropertyList
RecursiveItemAddException	Exception thrown if there is an attempt to add an item as a child to itself.
Request	Encapsulates a Postman collection request.
RequestAuth	Postman SDK analog: RequestAuth.
RequestBody	Encapsulates the request object property of a Request
Response	Class to encapsulate the response object property of a Request.
Url	Class to encapsulate the properties in the url object of a RequestBody object.
ValidationException	Exception thrown if there is a system, syntax or other error/exception which interrupts or prevents actual validation of the element.
VariableResolutionException	Error thrown if something prevents the resolution of a variable value, eg., the specified variable doesn't exist, etc.