Resource blocks
Get all resource blocks
Returns all resource blocks (out of order blocks or internal use blocks). Note this operation uses Pagination and supports Portfolio Access Tokens.
Request
[PlatformAddress]/api/connector/v1/resourceBlocks/getAll
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of string | optional, max 1000 items | Unique identifiers of the Enterprises. If not specified, the operation returns data for all enterprises within scope of the Access Token. |
| array of string | optional, max 1000 items | Unique identifiers of the requested Resource blocks. |
| array of string | optional, max 1000 items | Unique identifiers of the requested Assigned Resources. |
| optional, max length 3 months | Interval in which the Resource block is active. | |
| optional, max length 3 months | Interval in which the Resource block was created. | |
| optional, max length 3 months | Interval in which the Resource block was updated. | |
| required | Extent of data to be returned. | |
| required | Limitation on the quantity of data returned. |
Resource block extent
Property | Type | Contract | Description |
---|---|---|---|
| bool | required | Whether the response should contain inactive entities. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Resource block | required | The resource blocks colliding with the interval or matching the Id parameters. |
Resource block
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of the block. |
| string | required | Unique identifier of the assigned Resource. |
| bool | required | Whether the block is still active. |
| string Resource block type | required | Type of the resource block. |
| string | required | Start of the block in UTC timezone in ISO 8601 format. |
| string | required | End of the block in UTC timezone in ISO 8601 format. |
| string | required | Creation date and time of the block in UTC timezone in ISO 8601 format. |
| string | required | Last update date and time of the block in UTC timezone in ISO 8601 format. |
| string | required | Name of the resource block. |
| string | optional | Note describing the resource block. |
Resource block type
OutOfOrder
InternalUse
Add resource block
Adds a new resource block to the specified resource for a defined period of time.
Request
[PlatformAddress]/api/connector/v1/resourceBlocks/add
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of Resource block parameters | required | Resource block parameters. |
Resource block parameters
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Unique identifier of Resource. |
| string | required | Name of the resource block. |
| string | required | Start of the interval in UTC timezone in ISO 8601 format. |
| string | required | End of the interval in UTC timezone in ISO 8601 format. |
| string Resource block type | required | Type of the resource block. |
| string | optional | Note describing the resource block. |
Response
Property | Type | Contract | Description |
---|---|---|---|
| array of Resource blocks | required | Resource blocks added. |
Delete resource blocks
Removes specified resource blocks from the resources.
Request
[PlatformAddress]/api/connector/v1/resourceBlocks/delete
Property | Type | Contract | Description |
---|---|---|---|
| string | required | Token identifying the client application. |
| string | required | Access token of the client application. |
| string | required | Name and version of the client application. |
| array of string | required | Unique identifier of Resource blocks to be removed. |
Response
Last updated