rePostPrivate / Client / get_channel

get_channel¶

rePostPrivate.Client.get_channel(**kwargs)¶

Displays information about a channel in a private re:Post.

Request Syntax

response = client.get_channel(
    spaceId='string',
    channelId='string'
)

Parameters:

spaceId (string) –
[REQUIRED]

The unique ID of the private re:Post.
channelId (string) –
[REQUIRED]

The unique ID of the private re:Post channel.

Return type:

dict

Returns:

Response Syntax

{
    'spaceId': 'string',
    'channelId': 'string',
    'channelName': 'string',
    'channelDescription': 'string',
    'createDateTime': datetime(2015, 1, 1),
    'deleteDateTime': datetime(2015, 1, 1),
    'channelRoles': {
        'string': [
            'ASKER'|'EXPERT'|'MODERATOR'|'SUPPORTREQUESTOR',
        ]
    },
    'channelStatus': 'CREATED'|'CREATING'|'CREATE_FAILED'|'DELETED'|'DELETING'|'DELETE_FAILED'
}

Response Structure

(dict) –
- spaceId (string) –
  
  The unique ID of the private re:Post.
- channelId (string) –
  
  The unique ID of the private re:Post channel.
- channelName (string) –
  
  The name for the channel. This must be unique per private re:Post.
- channelDescription (string) –
  
  A description for the channel. This is used only to help you identify this channel.
- createDateTime (datetime) –
  
  The date when the channel was created.
- deleteDateTime (datetime) –
  
  The date when the channel was deleted.
- channelRoles (dict) –
  
  The channel roles associated to the users and groups of the channel.
  - (string) –
    - (list) –
      - (string) –
- channelStatus (string) –
  
  The status pf the channel.

Exceptions

rePostPrivate.Client.exceptions.ValidationException
rePostPrivate.Client.exceptions.AccessDeniedException
rePostPrivate.Client.exceptions.ResourceNotFoundException
rePostPrivate.Client.exceptions.ThrottlingException
rePostPrivate.Client.exceptions.InternalServerException