/// <summary> /// Get the next unconsumed test data queue item /// </summary> /// <remarks> /// Client Credentials Flow required permissions: TestDataQueues or /// TestDataQueues.Write. /// /// Required permissions: TestDataQueueItems.View. /// /// Responses: /// 200 Returns the next unconsumed test data queue item /// 204 If there are no unconsumed test data queue items in the queue /// 403 If the caller doesn't have permissions to view test data queue items /// 404 If the test data queue does not exist /// </remarks> /// <param name='operations'> /// The operations group for this extension method. /// </param> /// <param name='body'> /// QueueName:the test data queue name; SetConsumed: Whether to set the item's /// IsConsumed flag as true or false /// </param> /// <param name='xUIPATHOrganizationUnitId'> /// Folder/OrganizationUnit Id /// </param> public static TestDataQueueItemDto GetNextItem(this ITestDataQueueActions operations, TestDataQueueGetNextItemDto body = default(TestDataQueueGetNextItemDto), long?xUIPATHOrganizationUnitId = default(long?)) { return(operations.GetNextItemAsync(body, xUIPATHOrganizationUnitId).GetAwaiter().GetResult()); }
/// <summary> /// Get the next unconsumed test data queue item /// </summary> /// <remarks> /// Client Credentials Flow required permissions: TestDataQueues or /// TestDataQueues.Write. /// /// Required permissions: TestDataQueueItems.View. /// /// Responses: /// 200 Returns the next unconsumed test data queue item /// 204 If there are no unconsumed test data queue items in the queue /// 403 If the caller doesn't have permissions to view test data queue items /// 404 If the test data queue does not exist /// </remarks> /// <param name='operations'> /// The operations group for this extension method. /// </param> /// <param name='body'> /// QueueName:the test data queue name; SetConsumed: Whether to set the item's /// IsConsumed flag as true or false /// </param> /// <param name='xUIPATHOrganizationUnitId'> /// Folder/OrganizationUnit Id /// </param> /// <param name='cancellationToken'> /// The cancellation token. /// </param> public static async Task <TestDataQueueItemDto> GetNextItemAsync(this ITestDataQueueActions operations, TestDataQueueGetNextItemDto body = default(TestDataQueueGetNextItemDto), long?xUIPATHOrganizationUnitId = default(long?), CancellationToken cancellationToken = default(CancellationToken)) { using (var _result = await operations.GetNextItemWithHttpMessagesAsync(body, xUIPATHOrganizationUnitId, null, cancellationToken).ConfigureAwait(false)) { return(_result.Body); } }
/// <summary> /// Get the next unconsumed test data queue item /// </summary> /// <remarks> /// Client Credentials Flow required permissions: TestDataQueues or /// TestDataQueues.Write. /// /// Required permissions: TestDataQueueItems.View. /// /// Responses: /// 200 Returns the next unconsumed test data queue item /// 204 If there are no unconsumed test data queue items in the queue /// 403 If the caller doesn't have permissions to view test data queue items /// 404 If the test data queue does not exist /// </remarks> /// <param name='body'> /// QueueName:the test data queue name; SetConsumed: Whether to set the item's /// IsConsumed flag as true or false /// </param> /// <param name='xUIPATHOrganizationUnitId'> /// Folder/OrganizationUnit Id /// </param> /// <param name='customHeaders'> /// Headers that will be added to request. /// </param> /// <param name='cancellationToken'> /// The cancellation token. /// </param> /// <exception cref="HttpOperationException"> /// Thrown when the operation returned an invalid status code /// </exception> /// <exception cref="SerializationException"> /// Thrown when unable to deserialize the response /// </exception> /// <return> /// A response object containing the response body and response headers. /// </return> public async Task <HttpOperationResponse <TestDataQueueItemDto> > GetNextItemWithHttpMessagesAsync(TestDataQueueGetNextItemDto body = default(TestDataQueueGetNextItemDto), long?xUIPATHOrganizationUnitId = default(long?), Dictionary <string, List <string> > customHeaders = null, CancellationToken cancellationToken = default(CancellationToken)) { if (body != null) { body.Validate(); } // Tracing bool _shouldTrace = ServiceClientTracing.IsEnabled; string _invocationId = null; if (_shouldTrace) { _invocationId = ServiceClientTracing.NextInvocationId.ToString(); Dictionary <string, object> tracingParameters = new Dictionary <string, object>(); tracingParameters.Add("body", body); tracingParameters.Add("xUIPATHOrganizationUnitId", xUIPATHOrganizationUnitId); tracingParameters.Add("cancellationToken", cancellationToken); ServiceClientTracing.Enter(_invocationId, this, "GetNextItem", tracingParameters); } // Construct URL var _baseUrl = Client.BaseUri.AbsoluteUri; var _url = new System.Uri(new System.Uri(_baseUrl + (_baseUrl.EndsWith("/") ? "" : "/")), "api/TestDataQueueActions/GetNextItem").ToString(); // Create HTTP transport objects var _httpRequest = new HttpRequestMessage(); HttpResponseMessage _httpResponse = null; _httpRequest.Method = new HttpMethod("POST"); _httpRequest.RequestUri = new System.Uri(_url); // Set Headers if (xUIPATHOrganizationUnitId != null) { if (_httpRequest.Headers.Contains("X-UIPATH-OrganizationUnitId")) { _httpRequest.Headers.Remove("X-UIPATH-OrganizationUnitId"); } _httpRequest.Headers.TryAddWithoutValidation("X-UIPATH-OrganizationUnitId", Microsoft.Rest.Serialization.SafeJsonConvert.SerializeObject(xUIPATHOrganizationUnitId, Client.SerializationSettings).Trim('"')); } if (customHeaders != null) { foreach (var _header in customHeaders) { if (_httpRequest.Headers.Contains(_header.Key)) { _httpRequest.Headers.Remove(_header.Key); } _httpRequest.Headers.TryAddWithoutValidation(_header.Key, _header.Value); } } // Serialize Request string _requestContent = null; if (body != null) { _requestContent = Microsoft.Rest.Serialization.SafeJsonConvert.SerializeObject(body, Client.SerializationSettings); _httpRequest.Content = new StringContent(_requestContent, System.Text.Encoding.UTF8); _httpRequest.Content.Headers.ContentType = System.Net.Http.Headers.MediaTypeHeaderValue.Parse("application/json; charset=utf-8"); } // Send Request if (_shouldTrace) { ServiceClientTracing.SendRequest(_invocationId, _httpRequest); } cancellationToken.ThrowIfCancellationRequested(); _httpResponse = await Client.HttpClient.SendAsync(_httpRequest, cancellationToken).ConfigureAwait(false); if (_shouldTrace) { ServiceClientTracing.ReceiveResponse(_invocationId, _httpResponse); } HttpStatusCode _statusCode = _httpResponse.StatusCode; cancellationToken.ThrowIfCancellationRequested(); string _responseContent = null; if ((int)_statusCode != 200 && (int)_statusCode != 204) { var ex = new HttpOperationException(string.Format("Operation returned an invalid status code '{0}'", _statusCode)); if (_httpResponse.Content != null) { _responseContent = await _httpResponse.Content.ReadAsStringAsync().ConfigureAwait(false); } else { _responseContent = string.Empty; } ex.Request = new HttpRequestMessageWrapper(_httpRequest, _requestContent); ex.Response = new HttpResponseMessageWrapper(_httpResponse, _responseContent); if (_shouldTrace) { ServiceClientTracing.Error(_invocationId, ex); } _httpRequest.Dispose(); if (_httpResponse != null) { _httpResponse.Dispose(); } throw ex; } // Create Result var _result = new HttpOperationResponse <TestDataQueueItemDto>(); _result.Request = _httpRequest; _result.Response = _httpResponse; // Deserialize Response if ((int)_statusCode == 200) { _responseContent = await _httpResponse.Content.ReadAsStringAsync().ConfigureAwait(false); try { _result.Body = Microsoft.Rest.Serialization.SafeJsonConvert.DeserializeObject <TestDataQueueItemDto>(_responseContent, Client.DeserializationSettings); } catch (JsonException ex) { _httpRequest.Dispose(); if (_httpResponse != null) { _httpResponse.Dispose(); } throw new SerializationException("Unable to deserialize the response.", _responseContent, ex); } } if (_shouldTrace) { ServiceClientTracing.Exit(_invocationId, _result); } return(_result); }