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

ProfiledDocuments Resource

GET /projects/{usecase_id}

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
Response Body
media type data type description
application/json Iterable (JSON)

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}

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
Request Body
media type data type
application/json map of object (JSON)
Response Body
media type data type description
application/json Project (JSON)

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

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

GET /projects/{usecase_id}/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
Response Body
media type data type description
application/json Configuration (JSON)

Example

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

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

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

POST /projects/{usecase_id}/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
Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json Iterable (JSON)

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

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
Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json string (JSON)

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}

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    
usecase_id path    
force query false boolean
Response Body
media type data type description
application/json boolean (JSON)

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}

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
usecase_id path
Response Body
media type data type description
application/json Project (JSON)

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

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

PUT /projects/{usecase_id}/{project_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
usecase_id path
Request Body
media type data type
application/json map of object (JSON)
Response Body
media type data type description
application/json Project (JSON)

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

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

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

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    
usecase_id path    
force query false boolean
Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json Project (JSON)

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

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

PUT /projects/{usecase_id}/forceUnlock/{project_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
usecase_id path
Response Body
media type data type description
application/json Project (JSON)

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

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

POST /projects/{usecase_id}/registerFiles/{project_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
usecase_id path
Request Body
media type data type
application/json RegisterFileSetRequest (JSON)
Response Body
media type data type description
application/json Project (JSON)

Example

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

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

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

PUT /projects/{usecase_id}/setAccess/{project_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
usecase_id path
Request Body
media type data type
application/json Access (JSON)
Response Body
media type data type description
application/json Project (JSON)

Example

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

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

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

POST /projects/{usecase_id}/step/{project_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
usecase_id path
Request Body
media type data type
application/json StepExecutionRequest (JSON)
Response Body
media type data type description
application/json Project (JSON)

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

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

DELETE /projects/{usecase_id}/{relationship}/{project_id}/{relationship_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
relationship_id path
usecase_id path
target_id query
target_ucd query
Response Body
media type data type description
application/json Project (JSON)

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

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

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

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    
relationship_id path    
usecase_id path    
deep query false boolean
Response Body
media type data type description
application/json string (JSON)

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}

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
relationship_id path
usecase_id path
target_id query
target_ucd query
Response Body
media type data type description
application/json Project (JSON)

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

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