Resource blocks
Last updated
Was this helpful?
Last updated
Was this helpful?
Returns all resource blocks (out of order blocks or internal use blocks). Note this operation uses and supports .
[PlatformAddress]/api/connector/v1/resourceBlocks/getAll
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
EnterpriseIds
array of string
optional, max 1000 items
ResourceBlockIds
array of string
optional, max 1000 items
AssignedResourceIds
array of string
optional, max 1000 items
CollidingUtc
optional, max length 3 months
CreatedUtc
optional, max length 3 months
UpdatedUtc
optional, max length 3 months
Extent
required
Extent of data to be returned.
Limitation
required
Limitation on the quantity of data returned.
Inactive
bool
required
Whether the response should contain inactive entities.
ResourceBlocks
required
The resource blocks colliding with the interval or matching the Id parameters.
Id
string
required
Unique identifier of the block.
AssignedResourceId
string
required
IsActive
bool
required
Whether the block is still active.
Type
required
Type of the resource block.
StartUtc
string
required
Start of the block in UTC timezone in ISO 8601 format.
EndUtc
string
required
End of the block in UTC timezone in ISO 8601 format.
CreatedUtc
string
required
Creation date and time of the block in UTC timezone in ISO 8601 format.
UpdatedUtc
string
required
Last update date and time of the block in UTC timezone in ISO 8601 format.
Name
string
required
Name of the resource block.
Notes
string
optional
Note describing the resource block.
OutOfOrder
InternalUse
Adds a new resource block to the specified resource for a defined period of time.
[PlatformAddress]/api/connector/v1/resourceBlocks/add
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ResourceBlocks
required
Resource block parameters.
ResourceId
string
required
Name
string
required
Name of the resource block.
StartUtc
string
required
Start of the interval in UTC timezone in ISO 8601 format.
EndUtc
string
required
End of the interval in UTC timezone in ISO 8601 format.
Type
required
Type of the resource block.
Notes
string
optional
Note describing the resource block.
ResourceBlocks
required
Resource blocks added.
Removes specified resource blocks from the resources.
[PlatformAddress]/api/connector/v1/resourceBlocks/delete
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.
ResourceBlockIds
array of string
required
Unique identifiers of the . If not specified, the operation returns data for all enterprises within scope of the Access Token.
Unique identifiers of the requested .
Unique identifiers of the requested Assigned .
Interval in which the is active.
Interval in which the was created.
Interval in which the was updated.
array of
Unique identifier of the assigned .
string
array of
Unique identifier of .
string
array of
Unique identifier of to be removed.