GridInformationApi

All URIs are relative to http://localhost:50051

MethodHTTP requestDescription
getgridrankGET /getgridrank/{grid}
getgridsizeGET /getgridsize/{grid}
getgridtypeGET /getgridtype/{grid}

getgridrank

getgridrank(req::HTTP.Request, grid::Int64;) -> Int64

Given a grid identifier, get the rank (the number of dimensions) of that grid as an integer.

Required Parameters

NameTypeDescriptionNotes
reqHTTP.RequestThe HTTP Request object
gridInt64[default to nothing]

Return type

Int64

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getgridsize

getgridsize(req::HTTP.Request, grid::Int64;) -> Int64

Given a grid identifier, get the total number of elements (or nodes) of that grid as an integer.

Required Parameters

NameTypeDescriptionNotes
reqHTTP.RequestThe HTTP Request object
gridInt64[default to nothing]

Return type

Int64

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getgridtype

getgridtype(req::HTTP.Request, grid::Int64;) -> GetGridTypeResponse

Given a grid identifier, get the type of that grid as a string.

Required Parameters

NameTypeDescriptionNotes
reqHTTP.RequestThe HTTP Request object
gridInt64[default to nothing]

Return type

GetGridTypeResponse

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]