Foundry API

<back to all web services

GenerateMachineApiKeyRequest

Requires Authentication
The following routes are available for this service:
POST/machines/{Id}/generate-api-key
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    public static class GenerateMachineApiKeyRequest extends PostOperationTenanted<GenerateMachineApiKeyResponse>
    {
        public String id = null;
        
        public String getId() { return id; }
        public GenerateMachineApiKeyRequest setId(String value) { this.id = value; return this; }
    }

    public static class PostOperationTenanted<TResponse> extends PostOperationUnTenanted<TResponse> implements ITenantedRequest
    {
        public String organisationId = null;
        
        public String getOrganisationId() { return organisationId; }
        public PostOperationTenanted<TResponse> setOrganisationId(String value) { this.organisationId = value; return this; }
    }

    public static class PostOperationUnTenanted<TResponse> implements IPost
    {
        
    }

    public static class GenerateMachineApiKeyResponse
    {
        public ApiKey apiKey = null;
        public ResponseStatus responseStatus = null;
        
        public ApiKey getApiKey() { return apiKey; }
        public GenerateMachineApiKeyResponse setApiKey(ApiKey value) { this.apiKey = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public GenerateMachineApiKeyResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    public static class ApiKey implements IIdentifiableResource
    {
        public String userId = null;
        public String description = null;
        public Date expiresUtc = null;
        public String key = null;
        public String id = null;
        
        public String getUserId() { return userId; }
        public ApiKey setUserId(String value) { this.userId = value; return this; }
        public String getDescription() { return description; }
        public ApiKey setDescription(String value) { this.description = value; return this; }
        public Date getExpiresUtc() { return expiresUtc; }
        public ApiKey setExpiresUtc(Date value) { this.expiresUtc = value; return this; }
        public String getKey() { return key; }
        public ApiKey setKey(String value) { this.key = value; return this; }
        public String getId() { return id; }
        public ApiKey setId(String value) { this.id = value; return this; }
    }

}

Java GenerateMachineApiKeyRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /machines/{Id}/generate-api-key HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<GenerateMachineApiKeyRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Machines">
  <OrganisationId xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations">String</OrganisationId>
  <Id>String</Id>
</GenerateMachineApiKeyRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GenerateMachineApiKeyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infrastructure.Api.Interfaces.ServiceOperations.Machines">
  <ApiKey xmlns:d2p1="http://schemas.datacontract.org/2004/07/Application.Interfaces.Resources">
    <d2p1:Description>String</d2p1:Description>
    <d2p1:ExpiresUtc>0001-01-01T00:00:00</d2p1:ExpiresUtc>
    <d2p1:Id>String</d2p1:Id>
    <d2p1:Key>String</d2p1:Key>
    <d2p1:UserId>String</d2p1:UserId>
  </ApiKey>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GenerateMachineApiKeyResponse>