Jump to

• Request
• Response

Get a license inactivation or reactivation request record

get

/fscmRestApi/resources/11.13.18.05/publicSectorRecordActivationRequests/{RequestKey}

Request

Path Parameters

• RequestKey(required): integer(int64)
  This attribute indicates the unique identifier for the request.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  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: string
  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.

There's no request body for this operation.

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 : publicSectorRecordActivationRequests-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  This attribute indicates agency id.
• BusinessEntityId: string
  Maximum Length: 50

  The business entity ID for the inactivated entity object.
• BusinessEntityKey: integer (int64)
  The business entity key for the inactivated entity object.
• BusinessLocationId: string
  Maximum Length: 50

  The business location ID for the inactivated location object.
• BusinessLocationKey: integer (int64)
  The business location key for the inactivated location object.
• CompletedByName: string
  Title: Inactivated By

  Read Only: true

  Maximum Length: 255

  The name of agency staff that processed the change.
• CompletedOn: string (date-time)
  Title: Inactivated On

  This attribute indicates the date the change was completed.
• CreationDate: string (date-time)
  Read Only: true

  This attribute indicates the date and time of the creation of the row.
• EffChangeDate: string (date)
  Title: Effective Inactivation Date

  This attribute indicates the effective date of the license inactivation.
• InactivateReason: string
  Title: Reason for Inactivation

  Maximum Length: 30

  This attribute indicates the reason for the inactivation.
• LastUpdateDate: string (date-time)
  Read Only: true

  The user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LnpRecordId: string
  Maximum Length: 50

  The meaningful identifier for the transaction.
• LnpRecordKey: integer (int64)
  The unique identifier for the related transaction.
• ReactivateReason: string
  Maximum Length: 30

  The reason for the inactivation.
• RecordNumber: string
  Maximum Length: 64

  The parent transaction PUID that is also used by CRM import.
• RequestCode: string
  Maximum Length: 30

  The type of change requested.
• RequestDetails: string
  Title: Additional Details

  Maximum Length: 1000

  The details of the requests.
• RequestKey: integer (int64)
  This attribute indicates the unique identifier for the request.
• RequestorEmail: string
  Title: Requester Email

  Maximum Length: 320

  The email of the person requesting the change.
• RequestorName: string
  Title: Requester Name

  Maximum Length: 450

  The name of the person requesting the change.
• RequestorPhone: string
  Title: Requester Phone

  Maximum Length: 40

  The phone of the person requesting the change.
• RequestorStaffFlag: string
  Title: Requester is agency staff

  Maximum Length: 1

  Indicates that the staff initiated the request.
• RequestorTitle: string
  Title: Requester Title

  Maximum Length: 60

  The title of the person requesting the change.
• RequestPuid: string
  Maximum Length: 480

  The alternate key for the CRM import.
• RequestStatus: string
  Maximum Length: 30

  The status of the request.
• StatusHistoryPuid: string
  Maximum Length: 480

  The alternate key for CRM import.
• TransactionType: string
  Maximum Length: 10

  The transaction type related to the request.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"This attribute indicates the date and time of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusHistoryPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The alternate key for CRM import.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "TransactionType":{
            "maxLength":10,
            "type":"string",
            "description":"The transaction type related to the request.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "BusinessEntityId":{
            "maxLength":50,
            "type":"string",
            "description":"The business entity ID for the inactivated entity object.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"This attribute indicates agency id.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":8,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "CompletedByName":{
            "title":"Inactivated By",
            "maxLength":255,
            "type":"string",
            "description":"The name of agency staff that processed the change.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CompletedOn":{
            "title":"Inactivated On",
            "type":"string",
            "description":"This attribute indicates the date the change was completed.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "EffChangeDate":{
            "title":"Effective Inactivation Date",
            "type":"string",
            "description":"This attribute indicates the effective date of the license inactivation.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "RequestCode":{
            "maxLength":30,
            "type":"string",
            "description":"The type of change requested.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "BusinessEntityKey":{
            "type":"integer",
            "description":"The business entity key for the inactivated entity object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequestPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The alternate key for the CRM import.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "RequestorName":{
            "title":"Requester Name",
            "maxLength":450,
            "type":"string",
            "description":"The name of the person requesting the change.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "RequestorPhone":{
            "title":"Requester Phone",
            "maxLength":40,
            "type":"string",
            "description":"The phone of the person requesting the change.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "RequestorStaffFlag":{
            "title":"Requester is agency staff",
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the staff initiated the request.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LnpRecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The meaningful identifier for the transaction.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "BusinessLocationKey":{
            "type":"integer",
            "description":"The business location key for the inactivated location object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LnpRecordKey":{
            "type":"integer",
            "description":"The unique identifier for the related transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "InactivateReason":{
            "title":"Reason for Inactivation",
            "maxLength":30,
            "type":"string",
            "description":"This attribute indicates the reason for the inactivation.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "RequestorEmail":{
            "title":"Requester Email",
            "maxLength":320,
            "type":"string",
            "description":"The email of the person requesting the change.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "RequestDetails":{
            "title":"Additional Details",
            "maxLength":1000,
            "type":"string",
            "description":"The details of the requests.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "ReactivateReason":{
            "maxLength":30,
            "type":"string",
            "description":"The reason for the inactivation.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "BusinessLocationId":{
            "maxLength":50,
            "type":"string",
            "description":"The business location ID for the inactivated location object.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestKey":{
            "type":"integer",
            "description":"This attribute indicates the unique identifier for the request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_USER_KEY":"true",
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RecordNumber":{
            "maxLength":64,
            "type":"string",
            "description":"The parent transaction PUID that is also used by CRM import.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The user who last updated the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the request.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "RequestorTitle":{
            "title":"Requester Title",
            "maxLength":60,
            "type":"string",
            "description":"The title of the person requesting the change.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "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