Jump to

• Request
• Response

Update a license

patch

/fscmRestApi/resources/11.13.18.05/publicSectorLicenses/{LicenseReferenceId}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• LicenseReferenceId: integer
  The unique identifier for a license.

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorLicenses-item

Type: object

Show Source

• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the license.
• CreationDate(optional): string(date-time)
  The date and time when the license was created.
• LastActionBy(optional): string
  Maximum Length: 64

  The user who last verified the license.
• LastActionDate(optional): string(date-time)
  The date and time when the license was last verified.
• LastUpdateDate(optional): string(date-time)
  The date and time when the license was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the license.
• LicenseReferenceId(optional): integer(int64)
  The unique identifier for a license.
• links(optional): array Items
  Title: Items

  Link Relations
• ProfileId(optional): integer(int64)
  The registered public user profile that is associated with the license.
• ReferenceDescription(optional): string
  Title: Description

  Maximum Length: 360

  The description for the license.
• ReferenceExpireDate(optional): string(date-time)
  Title: Expire Date

  The license expiration date.
• ReferenceId(optional): string
  Title: License ID

  Maximum Length: 50

  The license number.
• ReferenceStartDate(optional): string(date-time)
  Title: Start Date

  The license issue date.
• ReferenceType(optional): string
  Maximum Length: 30

  The license type.
• VerificationStatus(optional): string
  Title: Verification Status

  Maximum Length: 2

  The license verification status.

{
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the license."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the license was created."
        },
        "LastActionBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last verified the license."
        },
        "LastActionDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the license was last verified."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the license was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the license."
        },
        "LicenseReferenceId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a license."
        },
        "ProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The registered public user profile that is associated with the license."
        },
        "ReferenceDescription":{
            "maxLength":360,
            "type":"string",
            "description":"The description for the license.",
            "title":"Description"
        },
        "ReferenceExpireDate":{
            "format":"date-time",
            "type":"string",
            "description":"The license expiration date.",
            "title":"Expire Date"
        },
        "ReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"The license number.",
            "title":"License ID"
        },
        "ReferenceStartDate":{
            "format":"date-time",
            "type":"string",
            "description":"The license issue date.",
            "title":"Start Date"
        },
        "ReferenceType":{
            "maxLength":30,
            "type":"string",
            "description":"The license type."
        },
        "VerificationStatus":{
            "maxLength":2,
            "type":"string",
            "description":"The license verification status.",
            "title":"Verification Status"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorLicenses-item

Type: object

Show Source

• CreatedBy(optional): string
  Maximum Length: 64

  The user who created the license.
• CreationDate(optional): string(date-time)
  The date and time when the license was created.
• LastActionBy(optional): string
  Maximum Length: 64

  The user who last verified the license.
• LastActionDate(optional): string(date-time)
  The date and time when the license was last verified.
• LastUpdateDate(optional): string(date-time)
  The date and time when the license was last updated.
• LastUpdatedBy(optional): string
  Maximum Length: 64

  The user who last updated the license.
• LicenseReferenceId(optional): integer(int64)
  The unique identifier for a license.
• links(optional): array Items
  Title: Items

  Link Relations
• ProfileId(optional): integer(int64)
  The registered public user profile that is associated with the license.
• ReferenceDescription(optional): string
  Title: Description

  Maximum Length: 360

  The description for the license.
• ReferenceExpireDate(optional): string(date-time)
  Title: Expire Date

  The license expiration date.
• ReferenceId(optional): string
  Title: License ID

  Maximum Length: 50

  The license number.
• ReferenceStartDate(optional): string(date-time)
  Title: Start Date

  The license issue date.
• ReferenceType(optional): string
  Maximum Length: 30

  The license type.
• VerificationStatus(optional): string
  Title: Verification Status

  Maximum Length: 2

  The license verification status.

{
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the license."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the license was created."
        },
        "LastActionBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last verified the license."
        },
        "LastActionDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the license was last verified."
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the license was last updated."
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the license."
        },
        "LicenseReferenceId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for a license."
        },
        "ProfileId":{
            "format":"int64",
            "type":"integer",
            "description":"The registered public user profile that is associated with the license."
        },
        "ReferenceDescription":{
            "maxLength":360,
            "type":"string",
            "description":"The description for the license.",
            "title":"Description"
        },
        "ReferenceExpireDate":{
            "format":"date-time",
            "type":"string",
            "description":"The license expiration date.",
            "title":"Expire Date"
        },
        "ReferenceId":{
            "maxLength":50,
            "type":"string",
            "description":"The license number.",
            "title":"License ID"
        },
        "ReferenceStartDate":{
            "format":"date-time",
            "type":"string",
            "description":"The license issue date.",
            "title":"Start Date"
        },
        "ReferenceType":{
            "maxLength":30,
            "type":"string",
            "description":"The license type."
        },
        "VerificationStatus":{
            "maxLength":2,
            "type":"string",
            "description":"The license verification status.",
            "title":"Verification Status"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top