Foundry API

SearchJobsRequest

The following routes are available for this service:
GET	/jobs

Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Infrastructure.Api.Interfaces.ServiceOperations.Jobs
Imports Infrastructure.Api.Interfaces.ServiceOperations
Imports Application.Interfaces
Imports Application.Interfaces.Resources

Namespace Global

    Namespace Application.Interfaces

        Public Partial Class Filtering
            Public Sub New()
                Fields = New List(Of String)
            End Sub

            Public Overridable Property Fields As List(Of String)
        End Class

        Public Partial Class SearchMetadata
            Public Overridable Property Total As Integer
            Public Overridable Property Limit As Integer
            Public Overridable Property Offset As Integer
            Public Overridable Property Sort As Sorting
            Public Overridable Property Filter As Filtering
        End Class

        Public Enum SortDirection
            Ascending
            Descending
        End Enum

        Public Partial Class Sorting
            Public Overridable Property By As String
            Public Overridable Property Direction As SortDirection
        End Class
    End Namespace

    Namespace Application.Interfaces.Resources

        Public Partial Class Job
            Implements IIdentifiableResource
            Public Overridable Property MachineId As String
            Public Overridable Property Name As String
            Public Overridable Property TotalLayers As Integer
            Public Overridable Property StartedAt As Date
            Public Overridable Property FinishedAt As Nullable(Of Date)
            Public Overridable Property Aborted As Boolean
            Public Overridable Property Id As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations

        Public Partial Class GetOperationUnTenanted(Of TResponse)
            Implements IHasGetOptions
            Implements IGet
            Public Overridable Property Embed As String
        End Class

        Public Partial Class SearchOperationResponse
            Public Overridable Property Metadata As SearchMetadata
        End Class

        Public Partial Class SearchOperationTenanted(Of TResponse)
            Inherits SearchOperationUnTenanted(Of TResponse)
            Implements ITenantedRequest
            Public Overridable Property OrganisationId As String
        End Class

        Public Partial Class SearchOperationUnTenanted(Of TResponse)
            Inherits GetOperationUnTenanted(Of TResponse)
            Implements IHasSearchOptions
            Public Overridable Property Distinct As String
            Public Overridable Property Limit As Nullable(Of Integer)
            Public Overridable Property Offset As Nullable(Of Integer)
            Public Overridable Property Sort As String
            Public Overridable Property Filter As String
        End Class
    End Namespace

    Namespace Infrastructure.Api.Interfaces.ServiceOperations.Jobs

        Public Partial Class SearchJobsRequest
            Inherits SearchOperationTenanted(Of SearchJobsResponse)
            Public Overridable Property MachineId As String
            Public Overridable Property Completed As Nullable(Of Boolean)
        End Class

        Public Partial Class SearchJobsResponse
            Inherits SearchOperationResponse
            Public Sub New()
                Jobs = New List(Of Job)
            End Sub

            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Jobs As List(Of Job)
        End Class
    End Namespace
End Namespace

VB.NET SearchJobsRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /jobs HTTP/1.1 
Host: foundrystage-api-app.azurewebsites.net 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"jobs":[{"machineId":"String","name":"String","totalLayers":0,"finishedAt":null,"aborted":false,"id":"String"}],"metadata":{"total":0,"limit":0,"offset":0,"sort":{"by":"String","direction":"Ascending"},"filter":{"fields":["String"]}}}