Json API / Group

What can you do with undefined?


Properties

Property Details
undefined
"undefined": 483
Type: Number
This is the unique numeric identifier for the undefinedUnique identifier for the associated GroupActionType object.
undefined
"undefined": "Hello World"
Type: String
Unique identifier for the associated GroupActionType object.
undefined
"undefined": 884
Type: Number
Unique identifier for the associated GroupActionType object.
undefined
"undefined": 682
Type: Number
Unique identifier for the associated GroupActionType object.
undefined
"undefined": 835
Type: Number
Unique identifier for the associated GroupActionType object.
undefined
"undefined": "Hello World"
Type: String
Unique identifier for the associated GroupActionType object.


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • groupActionTypeId
  • userId
  • parentId
  • name
  • description

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the undefined object.

Standard PATCH objects:


End Points

DELETEapi/v1/JsonApi/Group/{id:int}
Delete an instance of the undefined object.
DELETEapi/v1/JsonApi/Group/{id:int}/Detail
Delete a Detail object from the undefined.
{id:int}Unique identifier for the undefined object.
GETapi/v1/JsonApi/Group
Retrieve all of the undefined objects.
GETapi/v1/JsonApi/Group/Metadata
Retrieve all of the meta data details of the undefined object.
GETapi/v1/JsonApi/Group/Metadata/{option}
Retrieve all the meta data details of the undefined object based on provided options.
{option}Metadata options for the undefined object.
GETapi/v1/JsonApi/Group/Paged
Retreive all of the undefined objects in a paged fashion.
GETapi/v1/JsonApi/Group/Paged/Detail
Retreive all of the undefined objects in a paged fashion with all object details.
GETapi/v1/JsonApi/Group/{id:int}
Retrieve an instance of the undefined object by it's ID.
{id:int}Unique identifier for the undefined object.
GETapi/v1/JsonApi/Group/{id:int}/Detail
Retreive all of the Detail objects for the specified undefined.
{id:int}Unique identifier for the undefined object.
PATCHapi/v1/JsonApi/Group/{id:int}/Detail
Update the undefined object and optionally make changes to any child objects.
POSTapi/v1/JsonApi/Group
Create a new instance of the undefined object.
POSTapi/v1/JsonApi/Group/Detail
Create a new instance of the undefined object.
PUTapi/v1/JsonApi/Group/{id:int}
Update an existing instance of the undefined object.
PUTapi/v1/JsonApi/Group/{id:int}/Detail
Update an existing instance of a Detail object that belongs to the undefined.
{id:int}Unique identifier for the undefined object.