GET api/admin/v1/opportunities/{opportunityId}

Details of the Opportunity

Request Information

URI Parameters

NameDescriptionTypeAdditional information
opportunityId

ID of the Opportunity

 integer

Required

Body Parameters

None

Response Information

Resource Description

Opportunity details

OpportunityDto
NameDescriptionTypeAdditional information
Number

Opportunity Number

 integer

None
OrganizationalUnit

Organizational Unit

 OrganizationalUnitMinDto

None
OpportunityType

Type of the opportunity

 OpportunityTypeMinDto

None
Customer

Customer

 CustomerMinDto

None
EstimatedValue

Amount of the estimated value

 decimal number

None
IsDeleted

True if the opportunity is logically deleted

 boolean

None
State

State of opportunity

 StateMinDto

None
Code

The short code of the element

 string

None
Description

The description of the element

 string

None
IsActive

True if the element is active, false otherwise

 boolean

None
Permissions

Permissions

 PermissionDto

None
CreationDate

Creation

 date

None
CreatedBy

The user who has made the insert

 UserMinDto

None
LastUpdateDate

Date of the last update

 date

None
LastUpdatedBy

The user who has made the last update

 UserMinDto

None
Id

Unique ID

 integer

None

Response Formats

application/json, text/json

Sample: 
{
  "Number": 1,
  "OrganizationalUnit": {
    "Code": "sample string 1",
    "Description": "sample string 2",
    "Id": 3
  },
  "OpportunityType": {
    "Code": "sample string 1",
    "Description": "sample string 2",
    "Id": 3
  },
  "Customer": {
    "Code": "sample string 1",
    "Description": "sample string 2",
    "Id": 3
  },
  "EstimatedValue": 2.0,
  "IsDeleted": true,
  "State": {
    "Description": "sample string 1",
    "Id": 2
  },
  "Code": "sample string 4",
  "Description": "sample string 5",
  "IsActive": true,
  "Permissions": {
    "CanModify": true,
    "CanDelete": true
  },
  "CreationDate": "2024-11-01T19:43:28.9278502+01:00",
  "CreatedBy": {
    "Login": "sample string 1",
    "FullName": "sample string 2",
    "Avatar": "sample string 3",
    "Id": 4
  },
  "LastUpdateDate": "2024-11-01T19:43:28.9278502+01:00",
  "LastUpdatedBy": {
    "Login": "sample string 1",
    "FullName": "sample string 2",
    "Avatar": "sample string 3",
    "Id": 4
  },
  "Id": 7
}

application/xml, text/xml

Sample: 
<OpportunityDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models">
  <Id>7</Id>
  <CreatedBy>
    <Id>4</Id>
    <Avatar>sample string 3</Avatar>
    <FullName>sample string 2</FullName>
    <Login>sample string 1</Login>
  </CreatedBy>
  <CreationDate>2024-11-01T19:43:28.9278502+01:00</CreationDate>
  <LastUpdateDate>2024-11-01T19:43:28.9278502+01:00</LastUpdateDate>
  <LastUpdatedBy>
    <Id>4</Id>
    <Avatar>sample string 3</Avatar>
    <FullName>sample string 2</FullName>
    <Login>sample string 1</Login>
  </LastUpdatedBy>
  <Code>sample string 4</Code>
  <Description>sample string 5</Description>
  <IsActive>true</IsActive>
  <Permissions>
    <CanDelete>true</CanDelete>
    <CanModify>true</CanModify>
  </Permissions>
  <Customer>
    <Id>3</Id>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
  </Customer>
  <EstimatedValue>2</EstimatedValue>
  <IsDeleted>true</IsDeleted>
  <Number>1</Number>
  <OpportunityType>
    <Id>3</Id>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
  </OpportunityType>
  <OrganizationalUnit>
    <Id>3</Id>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
  </OrganizationalUnit>
  <State>
    <Id>2</Id>
    <Description>sample string 1</Description>
  </State>
</OpportunityDto>