GET v1/Delivery/Repositories/{id}

User roles allowed to make this request: DomainAdministrator RepositoryManager

Permissions required to make this request: Repository.Read

Gets the repository for the provided identifier.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

The repository id.

integer

Required

Body Parameters

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "PlanId": 2
}

application/xml, text/xml

Sample:
<CreateRepositoryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models.Delivery">
  <Name>sample string 1</Name>
  <PlanId>2</PlanId>
</CreateRepositoryModel>

application/x-www-form-urlencoded

Sample:
Name=sample&PlanId=Int64

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

The repository associated to the identifier. If the repository doesn't exist, returns a NotFound response.

Response Message

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": 1,
    "Name": "sample string 2",
    "StatusId": 3,
    "PlanId": 1,
    "DatabaseName": "sample string 4",
    "CreatedBy": "sample string 5"
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "StatusId": 3,
    "PlanId": 1,
    "DatabaseName": "sample string 4",
    "CreatedBy": "sample string 5"
  }
]

application/xml, text/xml

Sample:
<ArrayOfRepositoryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models.Delivery">
  <RepositoryModel>
    <CreatedBy>sample string 5</CreatedBy>
    <DatabaseName>sample string 4</DatabaseName>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <PlanId>1</PlanId>
    <StatusId>3</StatusId>
  </RepositoryModel>
  <RepositoryModel>
    <CreatedBy>sample string 5</CreatedBy>
    <DatabaseName>sample string 4</DatabaseName>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <PlanId>1</PlanId>
    <StatusId>3</StatusId>
  </RepositoryModel>
</ArrayOfRepositoryModel>