D4Science D4Science Don't have a D4Science account? Create one Could not find what you are looking for? Contact us.

ProfiledDocuments Resource

The Class ProfiledDocuments.

GET /projects/{usecase_id}

List.

Request Parameters
name type description
Authorization header Bearer token, see https://dev.d4science.org/how-to-access-resources
Content-Type header application/json
usecase_id path the profile ID
Response Body
media type data type description
application/json Iterable (JSON) the iterable

Example

Request
GET /srv/projects/{usecase_id}
Content-Type: */*
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

POST /projects/{usecase_id}

Creates the new.

Request Parameters
name type description
Authorization header Bearer token, see https://dev.d4science.org/how-to-access-resources
Content-Type header application/json
usecase_id path the profile ID
Request Body
media type data type description
application/json map of object (JSON) the d
Response Body
media type data type description
application/json Project (JSON) the project

Example

Request
POST /srv/projects/{usecase_id}
Content-Type: application/json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "_profileVersion" : {
    "stable" : true,
    "type" : "IVY",
    "minor" : 12345,
    "build" : "...",
    "originalValue" : "...",
    "value" : "...",
    "patch" : 12345,
    "suffixTokens" : [ "...", "..." ],
    "major" : 12345
  },
  "_theDocument" : {
    "property1" : { },
    "property2" : { }
  },
  "_lock" : {
    "_info" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    },
    "_operation" : "...",
    "_id" : "..."
  },
  "_identificationReferences" : [ {
    "property1" : { },
    "property2" : { }
  }, {
    "property1" : { },
    "property2" : { }
  } ],
  "_profileID" : "...",
  "_relationships" : [ {
    "_targetUCD" : "...",
    "_targetID" : "...",
    "_relationshipName" : "..."
  }, {
    "_targetUCD" : "...",
    "_targetID" : "...",
    "_relationshipName" : "..."
  } ],
  "_id" : "...",
  "_version" : {
    "stable" : true,
    "type" : "STRICT",
    "minor" : 12345,
    "build" : "...",
    "originalValue" : "...",
    "value" : "...",
    "patch" : 12345,
    "suffixTokens" : [ "...", "..." ],
    "major" : 12345
  },
  "_lifecycleInformation" : {
    "_lastInvokedStep" : "...",
    "_triggeredEvents" : [ {
      "event" : "...",
      "errorMessages" : [ "...", "..." ],
      "lastOperationStatus" : "ERROR",
      "warningMessages" : [ "...", "..." ]
    }, {
      "event" : "...",
      "errorMessages" : [ "...", "..." ],
      "lastOperationStatus" : "ERROR",
      "warningMessages" : [ "...", "..." ]
    } ],
    "_lastOperationStatus" : "OK",
    "_errorMessages" : [ "...", "..." ],
    "_phase" : "...",
    "_warningMessages" : [ "...", "..." ],
    "_notes" : "..."
  },
  "_info" : {
    "_access" : {
      "_policy" : "OPEN",
      "_license" : "..."
    },
    "_lastEditInfo" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    },
    "_creationInfo" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    }
  }
}

GET /projects/{usecase_id}/configuration

Gets the configuration.

Request Parameters
name type description
Authorization header Bearer token, see https://dev.d4science.org/how-to-access-resources
Content-Type header application/json
usecase_id path the profile ID
Response Body
media type data type description
application/json Configuration (JSON) the configuration

Example

Request
GET /srv/projects/{usecase_id}/configuration
Content-Type: */*
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "indexes" : [ {
    "property1" : { },
    "property2" : { }
  }, {
    "property1" : { },
    "property2" : { }
  } ],
  "status" : "ERROR",
  "archives" : [ {
    "property1" : { },
    "property2" : { }
  }, {
    "property1" : { },
    "property2" : { }
  } ],
  "last_updated_time" : "...",
  "context" : "...",
  "warningMessages" : [ "...", "..." ],
  "profile_id" : "...",
  "errorMessages" : [ "...", "..." ]
}

POST /projects/{usecase_id}/query

Query.

Request Parameters
name type description
Authorization header Bearer token, see https://dev.d4science.org/how-to-access-resources
Content-Type header application/json
usecase_id path the profile ID
Request Body
media type data type description
application/json string (JSON) the query string
Response Body
media type data type description
application/json Iterable (JSON) the iterable

Example

Request
POST /srv/projects/{usecase_id}/query
Content-Type: application/json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }

POST /projects/{usecase_id}/search

Search.

Request Parameters
name type description
Authorization header Bearer token, see https://dev.d4science.org/how-to-access-resources
Content-Type header application/json
usecase_id path the profile ID
Request Body
media type data type description
application/json string (JSON) the filter
Response Body
media type data type description
application/json string (JSON) the string

Example

Request
POST /srv/projects/{usecase_id}/search
Content-Type: application/json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
...

DELETE /projects/{usecase_id}/{project_id}

Delete.

Request Parameters
name type description default constraints
Authorization header Bearer token, see https://dev.d4science.org/how-to-access-resources    
Content-Type header application/json    
project_id path the id    
usecase_id path the profile ID    
force query the force false boolean
Response Body
media type data type description
application/json boolean (JSON) the boolean

Example

Request
DELETE /srv/projects/{usecase_id}/{project_id}
Content-Type: */*
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
...

GET /projects/{usecase_id}/{project_id}

Gets the by id.

Request Parameters
name type description
Authorization header Bearer token, see https://dev.d4science.org/how-to-access-resources
Content-Type header application/json
project_id path the id
usecase_id path the profile ID
Response Body
media type data type description
application/json Project (JSON) the by id

Example

Request
GET /srv/projects/{usecase_id}/{project_id}
Content-Type: */*
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "_profileVersion" : {
    "stable" : true,
    "type" : "IVY",
    "minor" : 12345,
    "build" : "...",
    "originalValue" : "...",
    "value" : "...",
    "patch" : 12345,
    "suffixTokens" : [ "...", "..." ],
    "major" : 12345
  },
  "_theDocument" : {
    "property1" : { },
    "property2" : { }
  },
  "_lock" : {
    "_info" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    },
    "_operation" : "...",
    "_id" : "..."
  },
  "_identificationReferences" : [ {
    "property1" : { },
    "property2" : { }
  }, {
    "property1" : { },
    "property2" : { }
  } ],
  "_profileID" : "...",
  "_relationships" : [ {
    "_targetUCD" : "...",
    "_targetID" : "...",
    "_relationshipName" : "..."
  }, {
    "_targetUCD" : "...",
    "_targetID" : "...",
    "_relationshipName" : "..."
  } ],
  "_id" : "...",
  "_version" : {
    "stable" : true,
    "type" : "LOOSE",
    "minor" : 12345,
    "build" : "...",
    "originalValue" : "...",
    "value" : "...",
    "patch" : 12345,
    "suffixTokens" : [ "...", "..." ],
    "major" : 12345
  },
  "_lifecycleInformation" : {
    "_lastInvokedStep" : "...",
    "_triggeredEvents" : [ {
      "event" : "...",
      "errorMessages" : [ "...", "..." ],
      "lastOperationStatus" : "OK",
      "warningMessages" : [ "...", "..." ]
    }, {
      "event" : "...",
      "errorMessages" : [ "...", "..." ],
      "lastOperationStatus" : "WARNING",
      "warningMessages" : [ "...", "..." ]
    } ],
    "_lastOperationStatus" : "OK",
    "_errorMessages" : [ "...", "..." ],
    "_phase" : "...",
    "_warningMessages" : [ "...", "..." ],
    "_notes" : "..."
  },
  "_info" : {
    "_access" : {
      "_policy" : "OPEN",
      "_license" : "..."
    },
    "_lastEditInfo" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    },
    "_creationInfo" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    }
  }
}

PATCH /projects/{usecase_id}/{project_id}

Patch.

Request Parameters
name type description
Authorization header Bearer token, see https://dev.d4science.org/how-to-access-resources
Content-Type header application/json
project_id path the document id
usecase_id path the profile ID
Request Body
media type data type description
application/json map of object (JSON) the d
Response Body
media type data type description
application/json Project (JSON) the project

Example

Request
PATCH /srv/projects/{usecase_id}/{project_id}
Content-Type: application/json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "_profileVersion" : {
    "stable" : true,
    "type" : "STRICT",
    "minor" : 12345,
    "build" : "...",
    "originalValue" : "...",
    "value" : "...",
    "patch" : 12345,
    "suffixTokens" : [ "...", "..." ],
    "major" : 12345
  },
  "_theDocument" : {
    "property1" : { },
    "property2" : { }
  },
  "_lock" : {
    "_info" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    },
    "_operation" : "...",
    "_id" : "..."
  },
  "_identificationReferences" : [ {
    "property1" : { },
    "property2" : { }
  }, {
    "property1" : { },
    "property2" : { }
  } ],
  "_profileID" : "...",
  "_relationships" : [ {
    "_targetUCD" : "...",
    "_targetID" : "...",
    "_relationshipName" : "..."
  }, {
    "_targetUCD" : "...",
    "_targetID" : "...",
    "_relationshipName" : "..."
  } ],
  "_id" : "...",
  "_version" : {
    "stable" : true,
    "type" : "NPM",
    "minor" : 12345,
    "build" : "...",
    "originalValue" : "...",
    "value" : "...",
    "patch" : 12345,
    "suffixTokens" : [ "...", "..." ],
    "major" : 12345
  },
  "_lifecycleInformation" : {
    "_lastInvokedStep" : "...",
    "_triggeredEvents" : [ {
      "event" : "...",
      "errorMessages" : [ "...", "..." ],
      "lastOperationStatus" : "ERROR",
      "warningMessages" : [ "...", "..." ]
    }, {
      "event" : "...",
      "errorMessages" : [ "...", "..." ],
      "lastOperationStatus" : "ERROR",
      "warningMessages" : [ "...", "..." ]
    } ],
    "_lastOperationStatus" : "WARNING",
    "_errorMessages" : [ "...", "..." ],
    "_phase" : "...",
    "_warningMessages" : [ "...", "..." ],
    "_notes" : "..."
  },
  "_info" : {
    "_access" : {
      "_policy" : "EMBARGOED",
      "_license" : "..."
    },
    "_lastEditInfo" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    },
    "_creationInfo" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    }
  }
}

PUT /projects/{usecase_id}/{project_id}

Update.

Request Parameters
name type description
Authorization header Bearer token, see https://dev.d4science.org/how-to-access-resources
Content-Type header application/json
project_id path the document id
usecase_id path the profile ID
Request Body
media type data type description
application/json map of object (JSON) the d
Response Body
media type data type description
application/json Project (JSON) the project

Example

Request
PUT /srv/projects/{usecase_id}/{project_id}
Content-Type: application/json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "_profileVersion" : {
    "stable" : true,
    "type" : "LOOSE",
    "minor" : 12345,
    "build" : "...",
    "originalValue" : "...",
    "value" : "...",
    "patch" : 12345,
    "suffixTokens" : [ "...", "..." ],
    "major" : 12345
  },
  "_theDocument" : {
    "property1" : { },
    "property2" : { }
  },
  "_lock" : {
    "_info" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    },
    "_operation" : "...",
    "_id" : "..."
  },
  "_identificationReferences" : [ {
    "property1" : { },
    "property2" : { }
  }, {
    "property1" : { },
    "property2" : { }
  } ],
  "_profileID" : "...",
  "_relationships" : [ {
    "_targetUCD" : "...",
    "_targetID" : "...",
    "_relationshipName" : "..."
  }, {
    "_targetUCD" : "...",
    "_targetID" : "...",
    "_relationshipName" : "..."
  } ],
  "_id" : "...",
  "_version" : {
    "stable" : true,
    "type" : "NPM",
    "minor" : 12345,
    "build" : "...",
    "originalValue" : "...",
    "value" : "...",
    "patch" : 12345,
    "suffixTokens" : [ "...", "..." ],
    "major" : 12345
  },
  "_lifecycleInformation" : {
    "_lastInvokedStep" : "...",
    "_triggeredEvents" : [ {
      "event" : "...",
      "errorMessages" : [ "...", "..." ],
      "lastOperationStatus" : "OK",
      "warningMessages" : [ "...", "..." ]
    }, {
      "event" : "...",
      "errorMessages" : [ "...", "..." ],
      "lastOperationStatus" : "ERROR",
      "warningMessages" : [ "...", "..." ]
    } ],
    "_lastOperationStatus" : "WARNING",
    "_errorMessages" : [ "...", "..." ],
    "_phase" : "...",
    "_warningMessages" : [ "...", "..." ],
    "_notes" : "..."
  },
  "_info" : {
    "_access" : {
      "_policy" : "OPEN",
      "_license" : "..."
    },
    "_lastEditInfo" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    },
    "_creationInfo" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    }
  }
}

POST /projects/{usecase_id}/deleteFiles/{project_id}

Delete file set. the Authorization must be a VRE token

Request Parameters
name type description default constraints
Authorization header VRE Bearer token, see https://dev.d4science.org/how-to-access-resources    
Content-Type header application/json    
project_id path the id    
usecase_id path the profile ID    
force query the force false boolean
ignore_errors query false boolean
Request Body
media type data type description
application/json string (JSON) the path must be passed as text in the body
Response Body
media type data type description
application/json Project (JSON) the project

Example

Request
POST /srv/projects/{usecase_id}/deleteFiles/{project_id}
Content-Type: application/json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "_profileVersion" : {
    "stable" : true,
    "type" : "NPM",
    "minor" : 12345,
    "build" : "...",
    "originalValue" : "...",
    "value" : "...",
    "patch" : 12345,
    "suffixTokens" : [ "...", "..." ],
    "major" : 12345
  },
  "_theDocument" : {
    "property1" : { },
    "property2" : { }
  },
  "_lock" : {
    "_info" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    },
    "_operation" : "...",
    "_id" : "..."
  },
  "_identificationReferences" : [ {
    "property1" : { },
    "property2" : { }
  }, {
    "property1" : { },
    "property2" : { }
  } ],
  "_profileID" : "...",
  "_relationships" : [ {
    "_targetUCD" : "...",
    "_targetID" : "...",
    "_relationshipName" : "..."
  }, {
    "_targetUCD" : "...",
    "_targetID" : "...",
    "_relationshipName" : "..."
  } ],
  "_id" : "...",
  "_version" : {
    "stable" : true,
    "type" : "NPM",
    "minor" : 12345,
    "build" : "...",
    "originalValue" : "...",
    "value" : "...",
    "patch" : 12345,
    "suffixTokens" : [ "...", "..." ],
    "major" : 12345
  },
  "_lifecycleInformation" : {
    "_lastInvokedStep" : "...",
    "_triggeredEvents" : [ {
      "event" : "...",
      "errorMessages" : [ "...", "..." ],
      "lastOperationStatus" : "ERROR",
      "warningMessages" : [ "...", "..." ]
    }, {
      "event" : "...",
      "errorMessages" : [ "...", "..." ],
      "lastOperationStatus" : "OK",
      "warningMessages" : [ "...", "..." ]
    } ],
    "_lastOperationStatus" : "WARNING",
    "_errorMessages" : [ "...", "..." ],
    "_phase" : "...",
    "_warningMessages" : [ "...", "..." ],
    "_notes" : "..."
  },
  "_info" : {
    "_access" : {
      "_policy" : "EMBARGOED",
      "_license" : "..."
    },
    "_lastEditInfo" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    },
    "_creationInfo" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    }
  }
}

PUT /projects/{usecase_id}/forceUnlock/{project_id}

Force unlock.

Request Parameters
name type description
Authorization header Bearer token, see https://dev.d4science.org/how-to-access-resources
Content-Type header application/json
project_id path the id
usecase_id path the profile ID
Response Body
media type data type description
application/json Project (JSON) the project

Example

Request
PUT /srv/projects/{usecase_id}/forceUnlock/{project_id}
Content-Type: application/json
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "_profileVersion" : {
    "stable" : true,
    "type" : "IVY",
    "minor" : 12345,
    "build" : "...",
    "originalValue" : "...",
    "value" : "...",
    "patch" : 12345,
    "suffixTokens" : [ "...", "..." ],
    "major" : 12345
  },
  "_theDocument" : {
    "property1" : { },
    "property2" : { }
  },
  "_lock" : {
    "_info" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    },
    "_operation" : "...",
    "_id" : "..."
  },
  "_identificationReferences" : [ {
    "property1" : { },
    "property2" : { }
  }, {
    "property1" : { },
    "property2" : { }
  } ],
  "_profileID" : "...",
  "_relationships" : [ {
    "_targetUCD" : "...",
    "_targetID" : "...",
    "_relationshipName" : "..."
  }, {
    "_targetUCD" : "...",
    "_targetID" : "...",
    "_relationshipName" : "..."
  } ],
  "_id" : "...",
  "_version" : {
    "stable" : true,
    "type" : "NPM",
    "minor" : 12345,
    "build" : "...",
    "originalValue" : "...",
    "value" : "...",
    "patch" : 12345,
    "suffixTokens" : [ "...", "..." ],
    "major" : 12345
  },
  "_lifecycleInformation" : {
    "_lastInvokedStep" : "...",
    "_triggeredEvents" : [ {
      "event" : "...",
      "errorMessages" : [ "...", "..." ],
      "lastOperationStatus" : "WARNING",
      "warningMessages" : [ "...", "..." ]
    }, {
      "event" : "...",
      "errorMessages" : [ "...", "..." ],
      "lastOperationStatus" : "WARNING",
      "warningMessages" : [ "...", "..." ]
    } ],
    "_lastOperationStatus" : "OK",
    "_errorMessages" : [ "...", "..." ],
    "_phase" : "...",
    "_warningMessages" : [ "...", "..." ],
    "_notes" : "..."
  },
  "_info" : {
    "_access" : {
      "_policy" : "OPEN",
      "_license" : "..."
    },
    "_lastEditInfo" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    },
    "_creationInfo" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    }
  }
}

POST /projects/{usecase_id}/registerFiles/{project_id}

Register file set.

Request Parameters
name type description
Authorization header Bearer token, see https://dev.d4science.org/how-to-access-resources
Content-Type header application/json
project_id path the id
usecase_id path the profile ID
Request Body
media type data type description
application/json RegisterFileSetRequest (JSON) the request
Response Body
media type data type description
application/json Project (JSON) the project

Example

Request
POST /srv/projects/{usecase_id}/registerFiles/{project_id}
Content-Type: application/json
Accept: application/json
Authorization: ...

                
{
  "toSetAccess" : {
    "_policy" : "EMBARGOED",
    "_license" : "..."
  },
  "streams" : [ {
    "id" : "...",
    "url" : "...",
    "filename" : "..."
  }, {
    "id" : "...",
    "url" : "...",
    "filename" : "..."
  } ],
  "clashOption" : "APPEND",
  "attributes" : {
    "property1" : { },
    "property2" : { }
  },
  "fieldDefinitionPath" : "...",
  "parentPath" : "...",
  "fieldName" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "_profileVersion" : {
    "stable" : true,
    "type" : "COCOAPODS",
    "minor" : 12345,
    "build" : "...",
    "originalValue" : "...",
    "value" : "...",
    "patch" : 12345,
    "suffixTokens" : [ "...", "..." ],
    "major" : 12345
  },
  "_theDocument" : {
    "property1" : { },
    "property2" : { }
  },
  "_lock" : {
    "_info" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    },
    "_operation" : "...",
    "_id" : "..."
  },
  "_identificationReferences" : [ {
    "property1" : { },
    "property2" : { }
  }, {
    "property1" : { },
    "property2" : { }
  } ],
  "_profileID" : "...",
  "_relationships" : [ {
    "_targetUCD" : "...",
    "_targetID" : "...",
    "_relationshipName" : "..."
  }, {
    "_targetUCD" : "...",
    "_targetID" : "...",
    "_relationshipName" : "..."
  } ],
  "_id" : "...",
  "_version" : {
    "stable" : true,
    "type" : "STRICT",
    "minor" : 12345,
    "build" : "...",
    "originalValue" : "...",
    "value" : "...",
    "patch" : 12345,
    "suffixTokens" : [ "...", "..." ],
    "major" : 12345
  },
  "_lifecycleInformation" : {
    "_lastInvokedStep" : "...",
    "_triggeredEvents" : [ {
      "event" : "...",
      "errorMessages" : [ "...", "..." ],
      "lastOperationStatus" : "WARNING",
      "warningMessages" : [ "...", "..." ]
    }, {
      "event" : "...",
      "errorMessages" : [ "...", "..." ],
      "lastOperationStatus" : "OK",
      "warningMessages" : [ "...", "..." ]
    } ],
    "_lastOperationStatus" : "WARNING",
    "_errorMessages" : [ "...", "..." ],
    "_phase" : "...",
    "_warningMessages" : [ "...", "..." ],
    "_notes" : "..."
  },
  "_info" : {
    "_access" : {
      "_policy" : "RESTRICTED",
      "_license" : "..."
    },
    "_lastEditInfo" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    },
    "_creationInfo" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    }
  }
}

PUT /projects/{usecase_id}/setAccess/{project_id}

Sets the access policy.

Request Parameters
name type description
Authorization header Bearer token, see https://dev.d4science.org/how-to-access-resources
Content-Type header application/json
project_id path the id
usecase_id path the profile ID
Request Body
media type data type description
application/json Access (JSON) the to set
Response Body
media type data type description
application/json Project (JSON) the project

Example

Request
PUT /srv/projects/{usecase_id}/setAccess/{project_id}
Content-Type: application/json
Accept: application/json
Authorization: ...

                
{
  "_policy" : "RESTRICTED",
  "_license" : "..."
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "_profileVersion" : {
    "stable" : true,
    "type" : "NPM",
    "minor" : 12345,
    "build" : "...",
    "originalValue" : "...",
    "value" : "...",
    "patch" : 12345,
    "suffixTokens" : [ "...", "..." ],
    "major" : 12345
  },
  "_theDocument" : {
    "property1" : { },
    "property2" : { }
  },
  "_lock" : {
    "_info" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    },
    "_operation" : "...",
    "_id" : "..."
  },
  "_identificationReferences" : [ {
    "property1" : { },
    "property2" : { }
  }, {
    "property1" : { },
    "property2" : { }
  } ],
  "_profileID" : "...",
  "_relationships" : [ {
    "_targetUCD" : "...",
    "_targetID" : "...",
    "_relationshipName" : "..."
  }, {
    "_targetUCD" : "...",
    "_targetID" : "...",
    "_relationshipName" : "..."
  } ],
  "_id" : "...",
  "_version" : {
    "stable" : true,
    "type" : "NPM",
    "minor" : 12345,
    "build" : "...",
    "originalValue" : "...",
    "value" : "...",
    "patch" : 12345,
    "suffixTokens" : [ "...", "..." ],
    "major" : 12345
  },
  "_lifecycleInformation" : {
    "_lastInvokedStep" : "...",
    "_triggeredEvents" : [ {
      "event" : "...",
      "errorMessages" : [ "...", "..." ],
      "lastOperationStatus" : "OK",
      "warningMessages" : [ "...", "..." ]
    }, {
      "event" : "...",
      "errorMessages" : [ "...", "..." ],
      "lastOperationStatus" : "WARNING",
      "warningMessages" : [ "...", "..." ]
    } ],
    "_lastOperationStatus" : "ERROR",
    "_errorMessages" : [ "...", "..." ],
    "_phase" : "...",
    "_warningMessages" : [ "...", "..." ],
    "_notes" : "..."
  },
  "_info" : {
    "_access" : {
      "_policy" : "RESTRICTED",
      "_license" : "..."
    },
    "_lastEditInfo" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    },
    "_creationInfo" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    }
  }
}

POST /projects/{usecase_id}/step/{project_id}

Perform step.

Request Parameters
name type description
Authorization header Bearer token, see https://dev.d4science.org/how-to-access-resources
Content-Type header application/json
project_id path the id
usecase_id path the profile ID
Request Body
media type data type description
application/json StepExecutionRequest (JSON) the request
Response Body
media type data type description
application/json Project (JSON) the project

Example

Request
POST /srv/projects/{usecase_id}/step/{project_id}
Content-Type: application/json
Accept: application/json
Authorization: ...

                
{
  "options" : {
    "property1" : { },
    "property2" : { }
  },
  "stepID" : "..."
}
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "_profileVersion" : {
    "stable" : true,
    "type" : "COCOAPODS",
    "minor" : 12345,
    "build" : "...",
    "originalValue" : "...",
    "value" : "...",
    "patch" : 12345,
    "suffixTokens" : [ "...", "..." ],
    "major" : 12345
  },
  "_theDocument" : {
    "property1" : { },
    "property2" : { }
  },
  "_lock" : {
    "_info" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    },
    "_operation" : "...",
    "_id" : "..."
  },
  "_identificationReferences" : [ {
    "property1" : { },
    "property2" : { }
  }, {
    "property1" : { },
    "property2" : { }
  } ],
  "_profileID" : "...",
  "_relationships" : [ {
    "_targetUCD" : "...",
    "_targetID" : "...",
    "_relationshipName" : "..."
  }, {
    "_targetUCD" : "...",
    "_targetID" : "...",
    "_relationshipName" : "..."
  } ],
  "_id" : "...",
  "_version" : {
    "stable" : true,
    "type" : "NPM",
    "minor" : 12345,
    "build" : "...",
    "originalValue" : "...",
    "value" : "...",
    "patch" : 12345,
    "suffixTokens" : [ "...", "..." ],
    "major" : 12345
  },
  "_lifecycleInformation" : {
    "_lastInvokedStep" : "...",
    "_triggeredEvents" : [ {
      "event" : "...",
      "errorMessages" : [ "...", "..." ],
      "lastOperationStatus" : "WARNING",
      "warningMessages" : [ "...", "..." ]
    }, {
      "event" : "...",
      "errorMessages" : [ "...", "..." ],
      "lastOperationStatus" : "OK",
      "warningMessages" : [ "...", "..." ]
    } ],
    "_lastOperationStatus" : "OK",
    "_errorMessages" : [ "...", "..." ],
    "_phase" : "...",
    "_warningMessages" : [ "...", "..." ],
    "_notes" : "..."
  },
  "_info" : {
    "_access" : {
      "_policy" : "RESTRICTED",
      "_license" : "..."
    },
    "_lastEditInfo" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    },
    "_creationInfo" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    }
  }
}

DELETE /projects/{usecase_id}/{relationship}/{project_id}/{relationship_id}

Delete relation.

Request Parameters
name type description
Authorization header Bearer token, see https://dev.d4science.org/how-to-access-resources
Content-Type header application/json
project_id path the id
relationship_id path the relationship id
usecase_id path the profile ID
target_id query the target id
target_ucd query the target UCD
Response Body
media type data type description
application/json Project (JSON) the project

Example

Request
DELETE /srv/projects/{usecase_id}/{relationship}/{project_id}/{relationship_id}
Content-Type: */*
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "_profileVersion" : {
    "stable" : true,
    "type" : "LOOSE",
    "minor" : 12345,
    "build" : "...",
    "originalValue" : "...",
    "value" : "...",
    "patch" : 12345,
    "suffixTokens" : [ "...", "..." ],
    "major" : 12345
  },
  "_theDocument" : {
    "property1" : { },
    "property2" : { }
  },
  "_lock" : {
    "_info" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    },
    "_operation" : "...",
    "_id" : "..."
  },
  "_identificationReferences" : [ {
    "property1" : { },
    "property2" : { }
  }, {
    "property1" : { },
    "property2" : { }
  } ],
  "_profileID" : "...",
  "_relationships" : [ {
    "_targetUCD" : "...",
    "_targetID" : "...",
    "_relationshipName" : "..."
  }, {
    "_targetUCD" : "...",
    "_targetID" : "...",
    "_relationshipName" : "..."
  } ],
  "_id" : "...",
  "_version" : {
    "stable" : true,
    "type" : "COCOAPODS",
    "minor" : 12345,
    "build" : "...",
    "originalValue" : "...",
    "value" : "...",
    "patch" : 12345,
    "suffixTokens" : [ "...", "..." ],
    "major" : 12345
  },
  "_lifecycleInformation" : {
    "_lastInvokedStep" : "...",
    "_triggeredEvents" : [ {
      "event" : "...",
      "errorMessages" : [ "...", "..." ],
      "lastOperationStatus" : "WARNING",
      "warningMessages" : [ "...", "..." ]
    }, {
      "event" : "...",
      "errorMessages" : [ "...", "..." ],
      "lastOperationStatus" : "WARNING",
      "warningMessages" : [ "...", "..." ]
    } ],
    "_lastOperationStatus" : "OK",
    "_errorMessages" : [ "...", "..." ],
    "_phase" : "...",
    "_warningMessages" : [ "...", "..." ],
    "_notes" : "..."
  },
  "_info" : {
    "_access" : {
      "_policy" : "OPEN",
      "_license" : "..."
    },
    "_lastEditInfo" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    },
    "_creationInfo" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    }
  }
}

GET /projects/{usecase_id}/{relationship}/{project_id}/{relationship_id}

Gets the relationship chain.

Request Parameters
name type description default constraints
Authorization header Bearer token, see https://dev.d4science.org/how-to-access-resources    
Content-Type header application/json    
project_id path the id    
relationship_id path the relationship id    
usecase_id path the profile ID    
deep query the deep false boolean
Response Body
media type data type description
application/json string (JSON) the relationship chain

Example

Request
GET /srv/projects/{usecase_id}/{relationship}/{project_id}/{relationship_id}
Content-Type: */*
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

PUT /projects/{usecase_id}/{relationship}/{project_id}/{relationship_id}

Sets the relation.

Request Parameters
name type description
Authorization header Bearer token, see https://dev.d4science.org/how-to-access-resources
Content-Type header application/json
project_id path the id
relationship_id path the relationship id
usecase_id path the profile ID
target_id query the target id
target_ucd query the target UCD
Response Body
media type data type description
application/json Project (JSON) the project

Example

Request
PUT /srv/projects/{usecase_id}/{relationship}/{project_id}/{relationship_id}
Content-Type: */*
Accept: application/json
Authorization: ...

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "_profileVersion" : {
    "stable" : true,
    "type" : "IVY",
    "minor" : 12345,
    "build" : "...",
    "originalValue" : "...",
    "value" : "...",
    "patch" : 12345,
    "suffixTokens" : [ "...", "..." ],
    "major" : 12345
  },
  "_theDocument" : {
    "property1" : { },
    "property2" : { }
  },
  "_lock" : {
    "_info" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    },
    "_operation" : "...",
    "_id" : "..."
  },
  "_identificationReferences" : [ {
    "property1" : { },
    "property2" : { }
  }, {
    "property1" : { },
    "property2" : { }
  } ],
  "_profileID" : "...",
  "_relationships" : [ {
    "_targetUCD" : "...",
    "_targetID" : "...",
    "_relationshipName" : "..."
  }, {
    "_targetUCD" : "...",
    "_targetID" : "...",
    "_relationshipName" : "..."
  } ],
  "_id" : "...",
  "_version" : {
    "stable" : true,
    "type" : "IVY",
    "minor" : 12345,
    "build" : "...",
    "originalValue" : "...",
    "value" : "...",
    "patch" : 12345,
    "suffixTokens" : [ "...", "..." ],
    "major" : 12345
  },
  "_lifecycleInformation" : {
    "_lastInvokedStep" : "...",
    "_triggeredEvents" : [ {
      "event" : "...",
      "errorMessages" : [ "...", "..." ],
      "lastOperationStatus" : "OK",
      "warningMessages" : [ "...", "..." ]
    }, {
      "event" : "...",
      "errorMessages" : [ "...", "..." ],
      "lastOperationStatus" : "ERROR",
      "warningMessages" : [ "...", "..." ]
    } ],
    "_lastOperationStatus" : "ERROR",
    "_errorMessages" : [ "...", "..." ],
    "_phase" : "...",
    "_warningMessages" : [ "...", "..." ],
    "_notes" : "..."
  },
  "_info" : {
    "_access" : {
      "_policy" : "EMBARGOED",
      "_license" : "..."
    },
    "_lastEditInfo" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    },
    "_creationInfo" : {
      "_context" : { },
      "_instant" : "...",
      "_user" : { }
    }
  }
}