Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
{
"swagger" : "2.0",
"info" : {
"description" : "xxxxxxxxxxxxxxxx",
"version" : "0.1",
"title" : "xxxxxxxxxxxxxxxxx",
"contact" : {
"name" : "xxxxxxxxxxxxxxxx",
"url" : "https://www.xxxxxxxxxxxx"
}
},
"host" : "xxxxxxxxxxxxxx.net",
"basePath" : "/ws/rest/XXXXXXXXXX",
"schemes" : [ "https" ],
"paths" : {
"/Vault" : {
"post" : {
"summary" : "MAIN - WS Execute Vault (JSON)",
"consumes" : [ "application/json" ],
"produces" : [ "application/json" ],
"parameters" : [ {
"in" : "body",
"name" : "JSON VaultRequest",
"required" : true,
"schema" : {
"$ref" : "#/definitions/VaultRequest"
}
} ],
"responses" : {
"200" : {
"description" : "Success",
"schema" : {
"$ref" : "#/definitions/VaultResponse"
}
},
"400" : {
"$ref" : "#/responses/400"
},
"401" : {
"$ref" : "#/responses/401"
},
"404" : {
"$ref" : "#/responses/404"
},
"413" : {
"$ref" : "#/responses/413"
},
"500" : {
"$ref" : "#/responses/500"
},
"503" : {
"$ref" : "#/responses/503"
},
"522" : {
"$ref" : "#/responses/522"
},
"default" : {
"$ref" : "#/responses/default"
}
}
}
}
},
"securityDefinitions" : {
"basic" : {
"type" : "basic"
}
},
"definitions" : {
"VaultRequest" : {
"type" : "object",
"properties" : {
"SourceId" : {
"type" : "integer",
"format" : "int32",
"maxLength" : 5
},
"AllowPartialUpdate" : {
"type" : "boolean"
},
"Entities" : {
"type" : "array",
"items" : [ {
"type" : "object",
"properties" : {
"Id" : {
"type" : "string"
},
"CreationDate" : {
"type" : "string",
"format" : "date-time"
},
"RetentionDate" : {
"type" : "string",
"format" : "date-time"
},
"ConsentText" : {
"type" : "string"
},
"ConsentType" : {
"type" : "integer",
"format" : "int32"
},
"ConsentForm" : {
"type" : "integer",
"format" : "int32"
},
"VaultFields" : {
"type" : "array",
"items" : [ {
"type" : "object",
"properties" : {
"Id" : {
"type" : "integer",
"format" : "int32",
"maxLength" : 5
},
"SourceField" : {
"type" : "integer",
"format" : "int32"
},
"SourceFieldName" : {
"type" : "string"
},
"Value" : {
"type" : "string"
},
"ValueId" : {
"type" : "integer",
"format" : "int32"
},
"Operation" : {
"type" : "integer",
"format" : "int32"
}
}
} ]
}
}
} ]
}
}
},
"VaultResponse" : {
"type" : "object",
"properties" : {
"Messages" : {
"type" : "array",
"items" : [ {
"type" : "object",
"properties" : {
"Record" : {
"type" : "string"
},
"Messages" : {
"type" : "array",
"items" : [ {
"type" : "object",
"properties" : {
"Type" : {
"type" : "string"
},
"Id" : {
"type" : "string"
},
"Number" : {
"type" : "string"
},
"Message" : {
"type" : "string"
},
"Var1" : {
"type" : "string"
},
"Var2" : {
"type" : "string"
},
"Var3" : {
"type" : "string"
},
"Var4" : {
"type" : "string"
}
}
} ]
}
}
} ]
}
}
}
},
"responses" : {
"400" : {
"description" : "Bad Request - There are miscellaneous errors with the request, for example, mismatches between the request and what is allowed for the operation."
},
"401" : {
"description" : "Unauthorized or 403 Forbidden - Authentication errors."
},
"404" : {
"description" : "Not Found - Invalid URL path."
},
"413" : {
"description" : "Request Entity Too Large - The request data was too large. This is based on the SOA Input Size quota."
},
"500" : {
"description" : "Internal Server Error - This generic error message appears when an unexpected condition was encountered and a more specific message is not suitable."
},
"503" : {
"description" : "Service Unavailable - The caller has hit a throttle or the request was rejected because the Atom is starting or stopping."
},
"522" : {
"description" : "Connection Timed Out - This message is returned to the client when the SOA Worker Maximum Execution Time has been exceeded."
},
"default" : {
"description" : "Unidentified Exception"
}
},
"security" : [ {
"basic" : [ ]
} ]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.