PUT api/Audit

Request Information

URI Parameters

None.

Body Parameters

AuditJob
NameDescriptionTypeAdditional information
Name

string

None.

Type

string

None.

Scope

string

None.

TargetName

string

None.

TargetUuid

string

None.

ReportPath

string

None.

Status

string

None.

Note

string

None.

Uuid

string

None.

OrganizationUuid

string

None.

CreatedBy

string

None.

ModifiedBy

string

None.

Hidden

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Type": "Undefined",
  "Scope": "None",
  "TargetName": "sample string 4",
  "TargetUuid": "sample string 5",
  "ReportPath": "sample string 6",
  "ReportStorage": 1,
  "Status": "Undefined",
  "Note": "sample string 8",
  "StartImmediately": true,
  "LastRun": "2024-11-21T04:30:10.2588419-05:00",
  "RunsInterval": 1,
  "PackageUuid": "sample string 10",
  "PackageName": "sample string 11",
  "Progress": 12.0,
  "Runs": [
    {
      "Summary": true,
      "Id": 2,
      "BatchId": "sample string 3",
      "RunUuid": "sample string 4",
      "RunDate": "2024-11-21T04:30:10.2588419-05:00",
      "Processed": 6,
      "Fails": 7,
      "Success": 8,
      "Warnings": 9,
      "Outcome": "sample string 10",
      "Target": "sample string 11"
    },
    {
      "Summary": true,
      "Id": 2,
      "BatchId": "sample string 3",
      "RunUuid": "sample string 4",
      "RunDate": "2024-11-21T04:30:10.2588419-05:00",
      "Processed": 6,
      "Fails": 7,
      "Success": 8,
      "Warnings": 9,
      "Outcome": "sample string 10",
      "Target": "sample string 11"
    }
  ],
  "DerivativesTypes": [],
  "Derivatives": [],
  "Uuid": "sample string 13",
  "OrganizationUuid": "sample string 14",
  "CreatedOn": "2024-11-21T04:30:10.2598419-05:00",
  "CreatedBy": "sample string 17",
  "ModifiedOn": "2024-11-21T04:30:10.2598419-05:00",
  "ModifiedBy": "sample string 20",
  "Hidden": true
}

application/xml, text/xml

Sample:
<AuditJob xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities.Db">
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">sample string 17</CreatedBy>
  <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">2024-11-21T04:30:10.2598419-05:00</CreatedOn>
  <CreatedOnString xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">2024-11-21T04:30:10.2598419-05:00</CreatedOnString>
  <Hidden xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">true</Hidden>
  <ModifiedBy xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">sample string 20</ModifiedBy>
  <ModifiedOn xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">2024-11-21T04:30:10.2598419-05:00</ModifiedOn>
  <ModifiedOnString xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">2024-11-21T04:30:10.2598419-05:00</ModifiedOnString>
  <OrganizationUuid xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">sample string 14</OrganizationUuid>
  <Uuid xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">sample string 13</Uuid>
  <_id xmlns:d2p1="http://schemas.datacontract.org/2004/07/MongoDB.Bson" xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">
    <d2p1:_a>0</d2p1:_a>
    <d2p1:_b>0</d2p1:_b>
    <d2p1:_c>0</d2p1:_c>
  </_id>
  <Derivatives xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
  <DerivativesTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/TDR.Entities.TypesAndCategories" />
  <LastRun>2024-11-21T04:30:10.2588419-05:00</LastRun>
  <Name>sample string 1</Name>
  <Note>sample string 8</Note>
  <PackageName>sample string 11</PackageName>
  <PackageUuid>sample string 10</PackageUuid>
  <Progress>12</Progress>
  <ReportPath>sample string 6</ReportPath>
  <ReportStorage>AzureBlob</ReportStorage>
  <Runs>
    <AuditJobRunInfo>
      <BatchId>sample string 3</BatchId>
      <Fails>7</Fails>
      <Id>2</Id>
      <Outcome>sample string 10</Outcome>
      <Processed>6</Processed>
      <RunDate>2024-11-21T04:30:10.2588419-05:00</RunDate>
      <RunUuid>sample string 4</RunUuid>
      <Success>8</Success>
      <Summary>true</Summary>
      <Target>sample string 11</Target>
      <Warnings>9</Warnings>
    </AuditJobRunInfo>
    <AuditJobRunInfo>
      <BatchId>sample string 3</BatchId>
      <Fails>7</Fails>
      <Id>2</Id>
      <Outcome>sample string 10</Outcome>
      <Processed>6</Processed>
      <RunDate>2024-11-21T04:30:10.2588419-05:00</RunDate>
      <RunUuid>sample string 4</RunUuid>
      <Success>8</Success>
      <Summary>true</Summary>
      <Target>sample string 11</Target>
      <Warnings>9</Warnings>
    </AuditJobRunInfo>
  </Runs>
  <RunsInterval>Manual</RunsInterval>
  <Scope>None</Scope>
  <ScopeEnum>None</ScopeEnum>
  <StartImmediately>true</StartImmediately>
  <Status>Undefined</Status>
  <StatusEnum>Undefined</StatusEnum>
  <TargetName>sample string 4</TargetName>
  <TargetUuid>sample string 5</TargetUuid>
  <Type>Undefined</Type>
  <TypeEnum>Undefined</TypeEnum>
</AuditJob>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AuditJob
NameDescriptionTypeAdditional information
Name

string

None.

Type

string

None.

Scope

string

None.

TargetName

string

None.

TargetUuid

string

None.

ReportPath

string

None.

Status

string

None.

Note

string

None.

Uuid

string

None.

OrganizationUuid

string

None.

CreatedBy

string

None.

ModifiedBy

string

None.

Hidden

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Type": "Undefined",
  "Scope": "None",
  "TargetName": "sample string 4",
  "TargetUuid": "sample string 5",
  "ReportPath": "sample string 6",
  "ReportStorage": 1,
  "Status": "Undefined",
  "Note": "sample string 8",
  "StartImmediately": true,
  "LastRun": "2024-11-21T04:30:10.2598419-05:00",
  "RunsInterval": 1,
  "PackageUuid": "sample string 10",
  "PackageName": "sample string 11",
  "Progress": 12.0,
  "Runs": [
    {
      "Summary": true,
      "Id": 2,
      "BatchId": "sample string 3",
      "RunUuid": "sample string 4",
      "RunDate": "2024-11-21T04:30:10.2598419-05:00",
      "Processed": 6,
      "Fails": 7,
      "Success": 8,
      "Warnings": 9,
      "Outcome": "sample string 10",
      "Target": "sample string 11"
    },
    {
      "Summary": true,
      "Id": 2,
      "BatchId": "sample string 3",
      "RunUuid": "sample string 4",
      "RunDate": "2024-11-21T04:30:10.2598419-05:00",
      "Processed": 6,
      "Fails": 7,
      "Success": 8,
      "Warnings": 9,
      "Outcome": "sample string 10",
      "Target": "sample string 11"
    }
  ],
  "DerivativesTypes": [],
  "Derivatives": [],
  "Uuid": "sample string 13",
  "OrganizationUuid": "sample string 14",
  "CreatedOn": "2024-11-21T04:30:10.2598419-05:00",
  "CreatedBy": "sample string 17",
  "ModifiedOn": "2024-11-21T04:30:10.2598419-05:00",
  "ModifiedBy": "sample string 20",
  "Hidden": true
}

application/xml, text/xml

Sample:
<AuditJob xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities.Db">
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">sample string 17</CreatedBy>
  <CreatedOn xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">2024-11-21T04:30:10.2598419-05:00</CreatedOn>
  <CreatedOnString xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">2024-11-21T04:30:10.2598419-05:00</CreatedOnString>
  <Hidden xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">true</Hidden>
  <ModifiedBy xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">sample string 20</ModifiedBy>
  <ModifiedOn xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">2024-11-21T04:30:10.2598419-05:00</ModifiedOn>
  <ModifiedOnString xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">2024-11-21T04:30:10.2598419-05:00</ModifiedOnString>
  <OrganizationUuid xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">sample string 14</OrganizationUuid>
  <Uuid xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">sample string 13</Uuid>
  <_id xmlns:d2p1="http://schemas.datacontract.org/2004/07/MongoDB.Bson" xmlns="http://schemas.datacontract.org/2004/07/TDR.Entities">
    <d2p1:_a>0</d2p1:_a>
    <d2p1:_b>0</d2p1:_b>
    <d2p1:_c>0</d2p1:_c>
  </_id>
  <Derivatives xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" />
  <DerivativesTypes xmlns:d2p1="http://schemas.datacontract.org/2004/07/TDR.Entities.TypesAndCategories" />
  <LastRun>2024-11-21T04:30:10.2598419-05:00</LastRun>
  <Name>sample string 1</Name>
  <Note>sample string 8</Note>
  <PackageName>sample string 11</PackageName>
  <PackageUuid>sample string 10</PackageUuid>
  <Progress>12</Progress>
  <ReportPath>sample string 6</ReportPath>
  <ReportStorage>AzureBlob</ReportStorage>
  <Runs>
    <AuditJobRunInfo>
      <BatchId>sample string 3</BatchId>
      <Fails>7</Fails>
      <Id>2</Id>
      <Outcome>sample string 10</Outcome>
      <Processed>6</Processed>
      <RunDate>2024-11-21T04:30:10.2598419-05:00</RunDate>
      <RunUuid>sample string 4</RunUuid>
      <Success>8</Success>
      <Summary>true</Summary>
      <Target>sample string 11</Target>
      <Warnings>9</Warnings>
    </AuditJobRunInfo>
    <AuditJobRunInfo>
      <BatchId>sample string 3</BatchId>
      <Fails>7</Fails>
      <Id>2</Id>
      <Outcome>sample string 10</Outcome>
      <Processed>6</Processed>
      <RunDate>2024-11-21T04:30:10.2598419-05:00</RunDate>
      <RunUuid>sample string 4</RunUuid>
      <Success>8</Success>
      <Summary>true</Summary>
      <Target>sample string 11</Target>
      <Warnings>9</Warnings>
    </AuditJobRunInfo>
  </Runs>
  <RunsInterval>Manual</RunsInterval>
  <Scope>None</Scope>
  <ScopeEnum>None</ScopeEnum>
  <StartImmediately>true</StartImmediately>
  <Status>Undefined</Status>
  <StatusEnum>Undefined</StatusEnum>
  <TargetName>sample string 4</TargetName>
  <TargetUuid>sample string 5</TargetUuid>
  <Type>Undefined</Type>
  <TypeEnum>Undefined</TypeEnum>
</AuditJob>