Skip to main content
Feedback

QAD Redzone - Partner operation

The QAD Redzone – Partner operation defines how to interact with the Redzone REST API. Each operation represents a specific action against a specific object to be executed against the Redzone API.

Actions

Create a separate operation component for each action and object combination required for your integration. The QAD Redzone – Partner operation features four different actions (Retrieve, Create, Update, or Delete) that can be used to interact with different objects in Redzone. Not all actions are available for every object.

Retrieve

This action is used to make GET calls to the Redzone API to retrieve data from Redzone, including List and Get actions.

  • Response Profile: The profile definition that represents the JSON structure received by the connector, if applicable.

  • Error Behavior: Select Error Behavior if you want to be able to act on failed operations in your process instead of only reporting them on the Manage page.

Dynamic Operation Properties – These values can be dynamically set on the
connector step or configured in the operation component.

  • Path organizationId: The identifier for your Redzone organization.

  • Path enterpriseId: The identifier for your Redzone enterprise.

  • Path {object}Id: For Get actions, to retrieve a specific instance of an object, the record id for that object is required.

For List actions, the additional fields are available to be set:

  • Query limit: integer, required. 1 to 100. Defaults to 20.

  • Query offset: integer, required. Value greater than 0. Defaults to 0.

  • Query active: boolean. Defaults to true. If false, only deactivated entities will be returned.

  • Query search: string. Optional. Provide a value to filter the results by. The connector appends this value to the search parameter.

Create

This action is used to make POST calls to the Redzone API to create new object records.

  • Request Profile: The profile definition that represents the JSON structure to be sent by the connector.

  • Response Profile: The profile definition that represents the JSON structure
    received by the connector, if applicable.

  • Error Behavior: Select Error Behavior if you want to be able to act on failed operations in your process instead of only reporting them on the Manage page.

Dynamic Operation Properties – These values can be dynamically set on the
connector step or configured in the operation component.

  • Path organizationId: The identifier for your Redzone organization.

  • Path enterpriseId: The identifier for your Redzone enterprise.

Update

This action is used to make PUT calls to the Redzone API to update existing object records.

  • Request Profile: The profile definition that represents the JSON structure to be sent by the connector.

  • Response Profile: The profile definition that represents the JSON structure
    received by the connector.

  • Error Behavior: Select Error Behavior if you want to be able to act on failed operations in your process instead of only reporting them on the Manage page.

Dynamic Operation Properties – These values can be dynamically set on the
connector step or configured in the operation component.

  • Path organizationId: The identifier for your Redzone organization.

  • Path enterpriseId: The identifier for your Redzone enterprise.

Delete

This action is used to make DELETE calls to the Redzone API to remove existing object records.

  • Response Profile: The profile definition that represents the JSON structure received by the connector, if applicable.

  • Error Behavior: Select Error Behavior if you want to be able to act on failed operations in your process instead of only reporting them on the Manage page.

Dynamic Operation Properties – These values can be dynamically set on the
connector step or configured in the operation component.

  • Path organizationId: The identifier for your Redzone organization.

  • Path enterpriseId: The identifier for your Redzone enterprise.

  • Path {object}Id: For Delete actions, to remove an instance of a specific object, the record id for that object is required.

Archiving tab

See the topic Connector operation’s Archiving tab for more information.

Tracking tab

See the topic Connector operation’s Tracking tab for more information.

Caching tab

See the topic Connector operation’s Caching tab for more information.

On this Page