Jump to

• Request
• Response

Update a license

patch

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

Request

Path Parameters

• LicenseReferenceId(required): integer(int64)
  The unique identifier for a license.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• LastActionBy: string
  Maximum Length: 64

  The user who last verified the license.
• LastActionDate: string (date-time)
  The date and time when the license was last verified.
• ProfileId: integer (int64)
  The registered public user profile that is associated with the license.
• ReferenceDescription: string
  Title: Description

  Maximum Length: 360

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

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

  Maximum Length: 50

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

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

  The license type.
• VerificationStatus: string
  Title: Verification Status

  Maximum Length: 2

  The license verification status.

{
    "type":"object",
    "properties":{
        "ProfileId":{
            "type":"integer",
            "description":"The registered public user profile that is associated with the license.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "VerificationStatus":{
            "title":"Verification Status",
            "maxLength":"2",
            "type":"string",
            "description":"The license verification status.",
            "nullable":true
        },
        "ReferenceId":{
            "title":"License ID",
            "maxLength":"50",
            "type":"string",
            "description":"The license number.",
            "nullable":false
        },
        "ReferenceDescription":{
            "title":"Description",
            "maxLength":"360",
            "type":"string",
            "description":"The description for the license.",
            "nullable":true
        },
        "ReferenceStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The license issue date.",
            "format":"date",
            "nullable":true
        },
        "LastActionBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last verified the license.",
            "nullable":true
        },
        "LastActionDate":{
            "type":"string",
            "description":"The date and time when the license was last verified.",
            "format":"date-time",
            "nullable":true
        },
        "ReferenceExpireDate":{
            "title":"Expire Date",
            "type":"string",
            "description":"The license expiration date.",
            "format":"date",
            "nullable":true
        },
        "ReferenceType":{
            "maxLength":"30",
            "type":"string",
            "description":"The license type.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorLicenses-item-response

Type: object

Show Source

• LastActionBy: string
  Maximum Length: 64

  The user who last verified the license.
• LastActionDate: string (date-time)
  The date and time when the license was last verified.
• LicenseReferenceId: integer (int64)
  The unique identifier for a license.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProfileId: integer (int64)
  The registered public user profile that is associated with the license.
• ReferenceDescription: string
  Title: Description

  Maximum Length: 360

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

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

  Maximum Length: 50

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

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

  The license type.
• VerificationStatus: string
  Title: Verification Status

  Maximum Length: 2

  The license verification status.

{
    "type":"object",
    "properties":{
        "LicenseReferenceId":{
            "type":"integer",
            "description":"The unique identifier for a license.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ProfileId":{
            "type":"integer",
            "description":"The registered public user profile that is associated with the license.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "VerificationStatus":{
            "title":"Verification Status",
            "maxLength":"2",
            "type":"string",
            "description":"The license verification status.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceId":{
            "title":"License ID",
            "maxLength":"50",
            "type":"string",
            "description":"The license number.",
            "nullable":false,
            "x-queryable":true
        },
        "ReferenceDescription":{
            "title":"Description",
            "maxLength":"360",
            "type":"string",
            "description":"The description for the license.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The license issue date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastActionBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last verified the license.",
            "nullable":true,
            "x-queryable":true
        },
        "LastActionDate":{
            "type":"string",
            "description":"The date and time when the license was last verified.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceExpireDate":{
            "title":"Expire Date",
            "type":"string",
            "description":"The license expiration date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceType":{
            "maxLength":"30",
            "type":"string",
            "description":"The license type.",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top