... | ... | @@ -15,24 +15,24 @@ |
|
|
|
|
|
## URL path
|
|
|
The various functionalities of the service are accessible through HTTP(S) URL built upon following pattern:
|
|
|
<service endpoint URL>/rest/<version>/<functionality>
|
|
|
\<service endpoint URL\>/rest/\<version\>/\<functionality\>
|
|
|
|
|
|
Here <service endpoint URL> represents mounting point of the service and may look like https://host.domain.org:443/arex .
|
|
|
The <version> is two parts number separated by '.' prefixed with 'v;. Current version is "v1.0".
|
|
|
The <functionality> is one of keywords defined below.
|
|
|
Here \<service endpoint URL\> represents mounting point of the service and may look like https://host.domain.org:443/arex .
|
|
|
The \<version\> is two parts number separated by '.' prefixed with 'v;. Current version is "v1.0".
|
|
|
The \<functionality\> is one of keywords defined below.
|
|
|
|
|
|
Further the part <service endpoint URL>/rest/<version> is referred as <base>.
|
|
|
Further the part \<service endpoint URL\>/rest/\<version\> is referred as \<base\>.
|
|
|
|
|
|
All parts of URL are case-sensitive.
|
|
|
|
|
|
GET with "Accept: text/html" on each resource returns HTML with some useful information for web browser compatibility.
|
|
|
|
|
|
Consider GET on <service endpoint URL>/rest return list of supported versions?
|
|
|
Consider GET on \<service endpoint URL\>/rest return list of supported versions?
|
|
|
|
|
|
|
|
|
## Functionality as resource.
|
|
|
Access to general functionality of the CE through URL.
|
|
|
<base URL>
|
|
|
\<base URL\>
|
|
|
Operations:
|
|
|
- GET - retrieve generic information about cluster (consider filtering through URL options), maybe shall include references (relative URLs) to underlying resources.
|
|
|
- HEAD - supported.
|
... | ... | @@ -40,7 +40,7 @@ Operations: |
|
|
|
|
|
|
|
|
## Delegation functionality.
|
|
|
<base URL>/delegations
|
|
|
\<base URL\>/delegations
|
|
|
Operations:
|
|
|
- GET - retrieves list of delegations belonging to authenticated user (consider paging through URL options) as text/html, application/xml or application/json.
|
|
|
- HEAD - supported.
|
... | ... | @@ -50,7 +50,7 @@ Operations: |
|
|
|
|
|
|
|
|
## Delegation as resource
|
|
|
<base URL>/delegations/<delegation id> - only available to owner of delegation
|
|
|
\<base URL\>/delegations/\<delegation id\> - only available to owner of delegation
|
|
|
Operations:
|
|
|
- GET - returns public part of the stored delegation as application/x-pem-file.
|
|
|
- HEAD - supported.
|
... | ... | @@ -60,7 +60,7 @@ Operations: |
|
|
|
|
|
|
|
|
## Job control functionality:
|
|
|
<base URL>/jobs
|
|
|
\<base URL\>/jobs
|
|
|
Operations:
|
|
|
- GET - retrieves list of jobs belonging to authenticated user (consider paging and filtering through URL options) as text/html, application/xml or application/json. Returned document contains minimal information about job - probably job state, references to selected sub-resources of the job. Also consider providing list of all jobs (or per-VO jobs) to special user identity (for monitoring).
|
|
|
- HEAD - supported.
|
... | ... | @@ -70,7 +70,7 @@ Operations: |
|
|
|
|
|
|
|
|
## Job as resource. Each job is represented by URL
|
|
|
<base URL>/jobs/<job id>
|
|
|
\<base URL\>/jobs/\<job id\>
|
|
|
Operations:
|
|
|
- GET - Retrieves full information about job (famous XML file, possibly automatically converted to JSON).
|
|
|
- HEAD - supported.
|
... | ... | @@ -80,7 +80,7 @@ Operations: |
|
|
|
|
|
## Sub-resources of the job.
|
|
|
### Session directory:
|
|
|
<base URL>/jobs/<job id>/session/...
|
|
|
\<base URL\>/jobs/\<job id\>/session/...
|
|
|
Operations:
|
|
|
- GET,HEAD,PUT,DELETE - supported for files stored in job's session directory and perform usual actions.
|
|
|
- GET,HEAD - for directories retrieves list of stored files (consider WebDAV for format).
|
... | ... | @@ -91,8 +91,8 @@ Operations: |
|
|
|
|
|
|
|
|
### Information about job.
|
|
|
<base URL>/jobs/<job id>/<information type>
|
|
|
For <information type> just follow controldir layout.
|
|
|
\<base URL\>/jobs/\<job id\>/\<information type\>
|
|
|
For \<information type\> just follow controldir layout.
|
|
|
Operations:
|
|
|
- GET - retrieves content of corresponding controldir file with type text/plain or application/xml according to file type.
|
|
|
- HEAD - supported.
|
... | ... | @@ -100,8 +100,8 @@ Operations: |
|
|
|
|
|
|
|
|
### Information about job's delegations.
|
|
|
<base URL>/jobs/<job id>/delegations
|
|
|
<base URL>/jobs/<job id>/delegations/<delegation id>
|
|
|
\<base URL\>/jobs/\<job id\>/delegations
|
|
|
\<base URL\>/jobs/\<job id\>/delegations/\<delegation id\>
|
|
|
Provides read-only access to delegations associated with the job identically to <base URL>/delegations (only GET,HEAD methods supported)
|
|
|
|
|
|
|