POST api/Invida/webhooks

Invida intergration - api/Invida/webhooks.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
JobId	string	None.
JobRef	string	None.
LocationId	string	None.
LocationDescription	string	None.
DescriptionShort	string	None.
DescriptionLong	string	None.
Due	string	None.
Instruction	IBMS_Cloud_API.Invida+Instruction	None.
ServiceTicket	IBMS_Cloud_API.Invida+ServiceTicket	None.
PlannedJob	IBMS_Cloud_API.Invida+PlannedJob	None.
WorkOrderID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "JobId": "sample string 1",
  "JobRef": "sample string 2",
  "LocationId": "sample string 3",
  "LocationDescription": "sample string 4",
  "DescriptionShort": "sample string 5",
  "DescriptionLong": "sample string 6",
  "Due": "sample string 7",
  "Instruction": {
    "JobInstructionId": "sample string 1",
    "Description": {},
    "InstructionText": "sample string 3",
    "Reference": "sample string 4"
  },
  "ServiceTicket": {
    "Created": {},
    "Edited": {},
    "Deleted": {},
    "ServiceTicketId": "sample string 4",
    "ServiceTicketReference": "sample string 5",
    "OtherReferences": [
      {},
      {}
    ],
    "StateDescription": "sample string 6",
    "RequestStatus": "sample string 7",
    "Description": "sample string 8",
    "Details": "sample string 9",
    "ReportedDate": {},
    "RequiredFromDate": {},
    "RequiredToDate": {},
    "Classification": {
      "ClassificationId": "sample string 1",
      "Description": "sample string 2",
      "Path": "sample string 3"
    },
    "TicketQueue": {
      "TicketQueueId": "sample string 1",
      "Description": "sample string 2"
    },
    "Impact": {
      "ImpactId": "sample string 1",
      "Description": "sample string 2",
      "Path": "sample string 3"
    },
    "ReporterName": "sample string 13",
    "ReporterTel": "sample string 14",
    "ReporterEmail": "sample string 15",
    "Locations": [
      {
        "ContainerId": "sample string 1",
        "Description": "sample string 2",
        "Path": "sample string 3"
      },
      {
        "ContainerId": "sample string 1",
        "Description": "sample string 2",
        "Path": "sample string 3"
      }
    ],
    "Tags": [
      {},
      {}
    ],
    "SLAs": {
      "Open": {
        "MustOccurAfter": {},
        "ShouldOccurBefore": {},
        "Actual": {}
      },
      "Respond": {
        "MustOccurAfter": {},
        "ShouldOccurBefore": {},
        "Actual": {}
      },
      "Arrange": {
        "MustOccurAfter": {},
        "ShouldOccurBefore": {},
        "Actual": {}
      },
      "Accept": {
        "MustOccurAfter": {},
        "ShouldOccurBefore": {},
        "Actual": {}
      },
      "Attend": {
        "MustOccurAfter": {},
        "ShouldOccurBefore": {},
        "Actual": {}
      },
      "Start": {
        "MustOccurAfter": {},
        "ShouldOccurBefore": {},
        "Actual": {}
      },
      "Contain": {
        "MustOccurAfter": {},
        "ShouldOccurBefore": {},
        "Actual": {}
      },
      "Complete": {
        "MustOccurAfter": {},
        "ShouldOccurBefore": {},
        "Actual": {}
      },
      "Close": {
        "MustOccurAfter": {},
        "ShouldOccurBefore": {},
        "Actual": {}
      }
    }
  },
  "PlannedJob": {
    "PlannedJobId": "sample string 1",
    "PlannedJobRef": "sample string 2",
    "DescriptionShort": "sample string 3",
    "DescriptionLong": "sample string 4",
    "StartDate": "sample string 5",
    "SuspendDate": "sample string 6",
    "PredefinedProgram": {
      "PredefinedProgramId": "sample string 1",
      "Description": "sample string 2",
      "Reference": "sample string 3"
    }
  },
  "WorkOrderID": 8
}

text/html

Sample:

{"JobId":"sample string 1","JobRef":"sample string 2","LocationId":"sample string 3","LocationDescription":"sample string 4","DescriptionShort":"sample string 5","DescriptionLong":"sample string 6","Due":"sample string 7","Instruction":{"JobInstructionId":"sample string 1","Description":{},"InstructionText":"sample string 3","Reference":"sample string 4"},"ServiceTicket":{"Created":{},"Edited":{},"Deleted":{},"ServiceTicketId":"sample string 4","ServiceTicketReference":"sample string 5","OtherReferences":[{},{}],"StateDescription":"sample string 6","RequestStatus":"sample string 7","Description":"sample string 8","Details":"sample string 9","ReportedDate":{},"RequiredFromDate":{},"RequiredToDate":{},"Classification":{"ClassificationId":"sample string 1","Description":"sample string 2","Path":"sample string 3"},"TicketQueue":{"TicketQueueId":"sample string 1","Description":"sample string 2"},"Impact":{"ImpactId":"sample string 1","Description":"sample string 2","Path":"sample string 3"},"ReporterName":"sample string 13","ReporterTel":"sample string 14","ReporterEmail":"sample string 15","Locations":[{"ContainerId":"sample string 1","Description":"sample string 2","Path":"sample string 3"},{"ContainerId":"sample string 1","Description":"sample string 2","Path":"sample string 3"}],"Tags":[{},{}],"SLAs":{"Open":{"MustOccurAfter":{},"ShouldOccurBefore":{},"Actual":{}},"Respond":{"MustOccurAfter":{},"ShouldOccurBefore":{},"Actual":{}},"Arrange":{"MustOccurAfter":{},"ShouldOccurBefore":{},"Actual":{}},"Accept":{"MustOccurAfter":{},"ShouldOccurBefore":{},"Actual":{}},"Attend":{"MustOccurAfter":{},"ShouldOccurBefore":{},"Actual":{}},"Start":{"MustOccurAfter":{},"ShouldOccurBefore":{},"Actual":{}},"Contain":{"MustOccurAfter":{},"ShouldOccurBefore":{},"Actual":{}},"Complete":{"MustOccurAfter":{},"ShouldOccurBefore":{},"Actual":{}},"Close":{"MustOccurAfter":{},"ShouldOccurBefore":{},"Actual":{}}}},"PlannedJob":{"PlannedJobId":"sample string 1","PlannedJobRef":"sample string 2","DescriptionShort":"sample string 3","DescriptionLong":"sample string 4","StartDate":"sample string 5","SuspendDate":"sample string 6","PredefinedProgram":{"PredefinedProgramId":"sample string 1","Description":"sample string 2","Reference":"sample string 3"}},"WorkOrderID":8}

application/xml, text/xml

Sample:

<Invida.UpdatedJob xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IBMS_Cloud_API">
  <DescriptionLong>sample string 6</DescriptionLong>
  <DescriptionShort>sample string 5</DescriptionShort>
  <Due>sample string 7</Due>
  <Instruction>
    <Description />
    <InstructionText>sample string 3</InstructionText>
    <JobInstructionId>sample string 1</JobInstructionId>
    <Reference>sample string 4</Reference>
  </Instruction>
  <JobId>sample string 1</JobId>
  <JobRef>sample string 2</JobRef>
  <LocationDescription>sample string 4</LocationDescription>
  <LocationId>sample string 3</LocationId>
  <PlannedJob>
    <DescriptionLong>sample string 4</DescriptionLong>
    <DescriptionShort>sample string 3</DescriptionShort>
    <PlannedJobId>sample string 1</PlannedJobId>
    <PlannedJobRef>sample string 2</PlannedJobRef>
    <PredefinedProgram>
      <Description>sample string 2</Description>
      <PredefinedProgramId>sample string 1</PredefinedProgramId>
      <Reference>sample string 3</Reference>
    </PredefinedProgram>
    <StartDate>sample string 5</StartDate>
    <SuspendDate>sample string 6</SuspendDate>
  </PlannedJob>
  <ServiceTicket>
    <Classification>
      <ClassificationId>sample string 1</ClassificationId>
      <Description>sample string 2</Description>
      <Path>sample string 3</Path>
    </Classification>
    <Created />
    <Deleted />
    <Description>sample string 8</Description>
    <Details>sample string 9</Details>
    <Edited />
    <Impact>
      <Description>sample string 2</Description>
      <ImpactId>sample string 1</ImpactId>
      <Path>sample string 3</Path>
    </Impact>
    <Locations>
      <Invida.Location>
        <ContainerId>sample string 1</ContainerId>
        <Description>sample string 2</Description>
        <Path>sample string 3</Path>
      </Invida.Location>
      <Invida.Location>
        <ContainerId>sample string 1</ContainerId>
        <Description>sample string 2</Description>
        <Path>sample string 3</Path>
      </Invida.Location>
    </Locations>
    <OtherReferences xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:anyType />
      <d3p1:anyType />
    </OtherReferences>
    <ReportedDate />
    <ReporterEmail>sample string 15</ReporterEmail>
    <ReporterName>sample string 13</ReporterName>
    <ReporterTel>sample string 14</ReporterTel>
    <RequestStatus>sample string 7</RequestStatus>
    <RequiredFromDate />
    <RequiredToDate />
    <SLAs>
      <Accept>
        <Actual />
        <MustOccurAfter />
        <ShouldOccurBefore />
      </Accept>
      <Arrange>
        <Actual />
        <MustOccurAfter />
        <ShouldOccurBefore />
      </Arrange>
      <Attend>
        <Actual />
        <MustOccurAfter />
        <ShouldOccurBefore />
      </Attend>
      <Close>
        <Actual />
        <MustOccurAfter />
        <ShouldOccurBefore />
      </Close>
      <Complete>
        <Actual />
        <MustOccurAfter />
        <ShouldOccurBefore />
      </Complete>
      <Contain>
        <Actual />
        <MustOccurAfter />
        <ShouldOccurBefore />
      </Contain>
      <Open>
        <Actual />
        <MustOccurAfter />
        <ShouldOccurBefore />
      </Open>
      <Respond>
        <Actual />
        <MustOccurAfter />
        <ShouldOccurBefore />
      </Respond>
      <Start>
        <Actual />
        <MustOccurAfter />
        <ShouldOccurBefore />
      </Start>
    </SLAs>
    <ServiceTicketId>sample string 4</ServiceTicketId>
    <ServiceTicketReference>sample string 5</ServiceTicketReference>
    <StateDescription>sample string 6</StateDescription>
    <Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:anyType />
      <d3p1:anyType />
    </Tags>
    <TicketQueue>
      <Description>sample string 2</Description>
      <TicketQueueId>sample string 1</TicketQueueId>
    </TicketQueue>
  </ServiceTicket>
  <WorkOrderID>8</WorkOrderID>
</Invida.UpdatedJob>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Object

None.

Response Formats

application/json, text/json, text/html

Sample:

{}

application/xml, text/xml

Sample:

<z:anyType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/" />