Jump to

• Request
• Response

Create synthetic test definition

post

/serviceapi/apm.dataserver/api/v1/synthetic/tests

Create the synthetic test definition object passing in the JSON application payload. For more information see Synthetic Tests.

Request

Supported Media Types

• multipart/form-data

Body ()

Root Schema : FormDataMultiPart

Type: object

Show Source

• bodyParts(optional): array bodyParts
• contentDisposition(optional): object ContentDisposition
• entity(optional): object entity
• fields(optional): object fields
  Additional Properties Allowed: additionalProperties
• headers(optional): object headers
  Additional Properties Allowed: additionalProperties
• mediaType(optional): object MediaType
• parameterizedHeaders(optional): object parameterizedHeaders
  Additional Properties Allowed: additionalProperties
• parent(optional): object MultiPart
• providers(optional): object Providers

{
    "type":"object",
    "properties":{
        "entity":{
            "type":"object"
        },
        "headers":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "mediaType":{
            "$ref":"#/definitions/MediaType"
        },
        "parent":{
            "$ref":"#/definitions/MultiPart"
        },
        "providers":{
            "$ref":"#/definitions/Providers"
        },
        "bodyParts":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BodyPart"
            }
        },
        "fields":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/FormDataBodyPart"
                }
            }
        },
        "contentDisposition":{
            "$ref":"#/definitions/ContentDisposition"
        },
        "parameterizedHeaders":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ParameterizedHeader"
                }
            }
        }
    }
}

Nested Schema : bodyParts

Type: array

Show Source

• Array of: object BodyPart

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/BodyPart"
    }
}

Nested Schema : ContentDisposition

Type: object

Show Source

• creationDate(optional): string(date-time)
• fileName(optional): string
• modificationDate(optional): string(date-time)
• parameters(optional): object parameters
  Additional Properties Allowed: additionalProperties
• readDate(optional): string(date-time)
• size(optional): integer(int64)
• type(optional): string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "fileName":{
            "type":"string"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "modificationDate":{
            "type":"string",
            "format":"date-time"
        },
        "readDate":{
            "type":"string",
            "format":"date-time"
        },
        "size":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : entity

Type: object

Nested Schema : fields

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/FormDataBodyPart"
        }
    }
}

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : MediaType

Type: object

Show Source

• parameters(optional): object parameters
  Additional Properties Allowed: additionalProperties
• subtype(optional): string
• type(optional): string
• wildcardSubtype(optional): boolean
  Default Value: false
• wildcardType(optional): boolean
  Default Value: false

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "subtype":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "wildcardType":{
            "type":"boolean",
            "default":false
        },
        "wildcardSubtype":{
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : parameterizedHeaders

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/ParameterizedHeader"
        }
    }
}

Nested Schema : MultiPart

Type: object

Show Source

• bodyParts(optional): array bodyParts
• contentDisposition(optional): object ContentDisposition
• entity(optional): object entity
• headers(optional): object headers
  Additional Properties Allowed: additionalProperties
• mediaType(optional): object MediaType
• parameterizedHeaders(optional): object parameterizedHeaders
  Additional Properties Allowed: additionalProperties
• parent(optional): object MultiPart
• providers(optional): object Providers

{
    "type":"object",
    "properties":{
        "entity":{
            "type":"object"
        },
        "headers":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "mediaType":{
            "$ref":"#/definitions/MediaType"
        },
        "parent":{
            "$ref":"#/definitions/MultiPart"
        },
        "providers":{
            "$ref":"#/definitions/Providers"
        },
        "bodyParts":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/BodyPart"
            }
        },
        "contentDisposition":{
            "$ref":"#/definitions/ContentDisposition"
        },
        "parameterizedHeaders":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ParameterizedHeader"
                }
            }
        }
    }
}

Nested Schema : Providers

Type: object

Nested Schema : BodyPart

Type: object

Show Source

• contentDisposition(optional): object ContentDisposition
• entity(optional): object entity
• headers(optional): object headers
  Additional Properties Allowed: additionalProperties
• mediaType(optional): object MediaType
• parameterizedHeaders(optional): object parameterizedHeaders
  Additional Properties Allowed: additionalProperties
• parent(optional): object MultiPart
• providers(optional): object Providers

{
    "type":"object",
    "properties":{
        "entity":{
            "type":"object"
        },
        "headers":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "mediaType":{
            "$ref":"#/definitions/MediaType"
        },
        "parent":{
            "$ref":"#/definitions/MultiPart"
        },
        "providers":{
            "$ref":"#/definitions/Providers"
        },
        "contentDisposition":{
            "$ref":"#/definitions/ContentDisposition"
        },
        "parameterizedHeaders":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ParameterizedHeader"
                }
            }
        }
    }
}

Nested Schema : entity

Type: object

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : parameterizedHeaders

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/ParameterizedHeader"
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: object ParameterizedHeader

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ParameterizedHeader"
    }
}

Nested Schema : ParameterizedHeader

Type: object

Show Source

• parameters(optional): object parameters
  Additional Properties Allowed: additionalProperties
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: object FormDataBodyPart

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/FormDataBodyPart"
    }
}

Nested Schema : FormDataBodyPart

Type: object

Show Source

• contentDisposition(optional): object ContentDisposition
• entity(optional): object entity
• formDataContentDisposition(optional): object FormDataContentDisposition
• headers(optional): object headers
  Additional Properties Allowed: additionalProperties
• mediaType(optional): object MediaType
• name(optional): string
• parameterizedHeaders(optional): object parameterizedHeaders
  Additional Properties Allowed: additionalProperties
• parent(optional): object MultiPart
• providers(optional): object Providers
• simple(optional): boolean
  Default Value: false
• value(optional): string

{
    "type":"object",
    "properties":{
        "entity":{
            "type":"object"
        },
        "headers":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "mediaType":{
            "$ref":"#/definitions/MediaType"
        },
        "parent":{
            "$ref":"#/definitions/MultiPart"
        },
        "providers":{
            "$ref":"#/definitions/Providers"
        },
        "contentDisposition":{
            "$ref":"#/definitions/ContentDisposition"
        },
        "simple":{
            "type":"boolean",
            "default":false
        },
        "formDataContentDisposition":{
            "$ref":"#/definitions/FormDataContentDisposition"
        },
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        },
        "parameterizedHeaders":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "$ref":"#/definitions/ParameterizedHeader"
                }
            }
        }
    }
}

Nested Schema : entity

Type: object

Nested Schema : FormDataContentDisposition

Type: object

Show Source

• creationDate(optional): string(date-time)
• fileName(optional): string
• modificationDate(optional): string(date-time)
• name(optional): string
• parameters(optional): object parameters
  Additional Properties Allowed: additionalProperties
• readDate(optional): string(date-time)
• size(optional): integer(int64)
• type(optional): string

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string"
        },
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "fileName":{
            "type":"string"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time"
        },
        "modificationDate":{
            "type":"string",
            "format":"date-time"
        },
        "readDate":{
            "type":"string",
            "format":"date-time"
        },
        "size":{
            "type":"integer",
            "format":"int64"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : parameterizedHeaders

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/ParameterizedHeader"
        }
    }
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: object ParameterizedHeader

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ParameterizedHeader"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: object ParameterizedHeader

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ParameterizedHeader"
    }
}

Nested Schema : bodyParts

Type: array

Show Source

• Array of: object BodyPart

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/BodyPart"
    }
}

Nested Schema : entity

Type: object

Nested Schema : headers

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : parameterizedHeaders

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "$ref":"#/definitions/ParameterizedHeader"
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: object ParameterizedHeader

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ParameterizedHeader"
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Synthetic Test created successfully. See Status Codes for special HTTP response status codes for operations on Synthetic Test.

Back to Top