Jump to

• Request
• Response

Create a snapshot setting instance

post

/fscmRestApi/resources/11.13.18.05/applicationSnapshotSettings

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• applicationStatuses: array Application Snapshot Settings Statuses
  Title: Application Snapshot Settings Statuses

  The application snapshot settings statuses resource stores the application statuses for which a snapshot of an application are taken.
• assignments: array Application Snapshot Settings Assignments
  Title: Application Snapshot Settings Assignments

  The application snapshot settings assignments resource lists the academic entities assigned to this application snapshot settings instance.
• SnapshotSetupCode(required): string
  Title: Snapshot Setup Code

  Maximum Length: 50

  The alternate unique identifier for a snapshot setting.
• SnapshotSetupDescription: string
  Title: Description

  Maximum Length: 240

  Description of the snapshot setting.
• SnapshotSetupName(required): string
  Title: Name

  Maximum Length: 100

  Name of the snapshot setting.

{
    "required":[
        "SnapshotSetupCode",
        "SnapshotSetupName"
    ],
    "type":"object",
    "properties":{
        "SnapshotSetupCode":{
            "title":"Snapshot Setup Code",
            "maxLength":"50",
            "type":"string",
            "description":"The alternate unique identifier for a snapshot setting.",
            "nullable":false
        },
        "SnapshotSetupDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the snapshot setting.",
            "nullable":true
        },
        "assignments":{
            "title":"Application Snapshot Settings Assignments",
            "type":"array",
            "description":"The application snapshot settings assignments resource lists the academic entities assigned to this application snapshot settings instance.",
            "items":{
                "$ref":"#/components/schemas/applicationSnapshotSettings-assignments-item-post-request"
            }
        },
        "applicationStatuses":{
            "title":"Application Snapshot Settings Statuses",
            "type":"array",
            "description":"The application snapshot settings statuses resource stores the application statuses for which a snapshot of an application are taken.",
            "items":{
                "$ref":"#/components/schemas/applicationSnapshotSettings-applicationStatuses-item-post-request"
            }
        },
        "SnapshotSetupName":{
            "title":"Name",
            "maxLength":"100",
            "type":"string",
            "description":"Name of the snapshot setting.",
            "nullable":false
        }
    }
}

Nested Schema : Application Snapshot Settings Statuses

Type: array

Title: Application Snapshot Settings Statuses

The application snapshot settings statuses resource stores the application statuses for which a snapshot of an application are taken.

Show Source

• Array of: object applicationSnapshotSettings-applicationStatuses-item-post-request

{
    "title":"Application Snapshot Settings Statuses",
    "type":"array",
    "description":"The application snapshot settings statuses resource stores the application statuses for which a snapshot of an application are taken.",
    "items":{
        "$ref":"#/components/schemas/applicationSnapshotSettings-applicationStatuses-item-post-request"
    }
}

Nested Schema : Application Snapshot Settings Assignments

Type: array

Title: Application Snapshot Settings Assignments

The application snapshot settings assignments resource lists the academic entities assigned to this application snapshot settings instance.

Show Source

• Array of: object applicationSnapshotSettings-assignments-item-post-request

{
    "title":"Application Snapshot Settings Assignments",
    "type":"array",
    "description":"The application snapshot settings assignments resource lists the academic entities assigned to this application snapshot settings instance.",
    "items":{
        "$ref":"#/components/schemas/applicationSnapshotSettings-assignments-item-post-request"
    }
}

Nested Schema : applicationSnapshotSettings-applicationStatuses-item-post-request

Type: object

Show Source

• ApplicationStatusCode: string
  Title: Application Status Code

  Maximum Length: 30

  The application status code associated with the snapshot setting.

{
    "type":"object",
    "properties":{
        "ApplicationStatusCode":{
            "title":"Application Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The application status code associated with the snapshot setting.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : applicationSnapshotSettings-assignments-item-post-request

Type: object

Show Source

• AssignedEntityId: integer (int64)
  Title: Entity ID

  The unique identifier of the associated entity.
• AssignedEntityTypeCode: string
  Title: Entity Type Code

  Maximum Length: 30

  The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.

{
    "type":"object",
    "properties":{
        "AssignedEntityTypeCode":{
            "title":"Entity Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssignedEntityId":{
            "title":"Entity ID",
            "type":"integer",
            "description":"The unique identifier of the associated entity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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

Type: object

Show Source

• applicationStatuses: array Application Snapshot Settings Statuses
  Title: Application Snapshot Settings Statuses

  The application snapshot settings statuses resource stores the application statuses for which a snapshot of an application are taken.
• assignments: array Application Snapshot Settings Assignments
  Title: Application Snapshot Settings Assignments

  The application snapshot settings assignments resource lists the academic entities assigned to this application snapshot settings instance.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the row was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• SnapshotSetupCode: string
  Title: Snapshot Setup Code

  Maximum Length: 50

  The alternate unique identifier for a snapshot setting.
• SnapshotSetupDescription: string
  Title: Description

  Maximum Length: 240

  Description of the snapshot setting.
• SnapshotSetupId: integer (int64)
  Title: Snapshot Setup ID

  Read Only: true

  The unique identifier for a snapshot setting.
• SnapshotSetupName: string
  Title: Name

  Maximum Length: 100

  Name of the snapshot setting.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SnapshotSetupDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the snapshot setting.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "assignments":{
            "title":"Application Snapshot Settings Assignments",
            "type":"array",
            "description":"The application snapshot settings assignments resource lists the academic entities assigned to this application snapshot settings instance.",
            "items":{
                "$ref":"#/components/schemas/applicationSnapshotSettings-assignments-item-response"
            }
        },
        "applicationStatuses":{
            "title":"Application Snapshot Settings Statuses",
            "type":"array",
            "description":"The application snapshot settings statuses resource stores the application statuses for which a snapshot of an application are taken.",
            "items":{
                "$ref":"#/components/schemas/applicationSnapshotSettings-applicationStatuses-item-response"
            }
        },
        "SnapshotSetupName":{
            "title":"Name",
            "maxLength":"100",
            "type":"string",
            "description":"Name of the snapshot setting.",
            "nullable":false,
            "x-queryable":true
        },
        "SnapshotSetupId":{
            "title":"Snapshot Setup ID",
            "type":"integer",
            "description":"The unique identifier for a snapshot setting.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SnapshotSetupCode":{
            "title":"Snapshot Setup Code",
            "maxLength":"50",
            "type":"string",
            "description":"The alternate unique identifier for a snapshot setting.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Application Snapshot Settings Statuses

Type: array

Title: Application Snapshot Settings Statuses

The application snapshot settings statuses resource stores the application statuses for which a snapshot of an application are taken.

Show Source

• Array of: object applicationSnapshotSettings-applicationStatuses-item-response

{
    "title":"Application Snapshot Settings Statuses",
    "type":"array",
    "description":"The application snapshot settings statuses resource stores the application statuses for which a snapshot of an application are taken.",
    "items":{
        "$ref":"#/components/schemas/applicationSnapshotSettings-applicationStatuses-item-response"
    }
}

Nested Schema : Application Snapshot Settings Assignments

Type: array

Title: Application Snapshot Settings Assignments

The application snapshot settings assignments resource lists the academic entities assigned to this application snapshot settings instance.

Show Source

• Array of: object applicationSnapshotSettings-assignments-item-response

{
    "title":"Application Snapshot Settings Assignments",
    "type":"array",
    "description":"The application snapshot settings assignments resource lists the academic entities assigned to this application snapshot settings instance.",
    "items":{
        "$ref":"#/components/schemas/applicationSnapshotSettings-assignments-item-response"
    }
}

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 : applicationSnapshotSettings-applicationStatuses-item-response

Type: object

Show Source

• ApplicationStatusCode: string
  Title: Application Status Code

  Maximum Length: 30

  The application status code associated with the snapshot setting.
• ApplicationStatusMeaning: string
  Title: Application Status

  Read Only: true

  Maximum Length: 80

  Meaning of the application status code.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SnapshotStatusId: integer (int64)
  Title: Snapshot Status ID

  Read Only: true

  The unique identifier for a snapshot settings application status.

{
    "type":"object",
    "properties":{
        "ApplicationStatusMeaning":{
            "title":"Application Status",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the application status code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SnapshotStatusId":{
            "title":"Snapshot Status ID",
            "type":"integer",
            "description":"The unique identifier for a snapshot settings application status.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ApplicationStatusCode":{
            "title":"Application Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"The application status code associated with the snapshot setting.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "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."
        }
    }
}

Nested Schema : applicationSnapshotSettings-assignments-item-response

Type: object

Show Source

• AssignedEntityCode: string
  Title: Entity Code

  Read Only: true

  Maximum Length: 100

  The user defined identifier of the associated entity.
• AssignedEntityId: integer (int64)
  Title: Entity ID

  The unique identifier of the associated entity.
• AssignedEntityName: string
  Title: Entity Name

  Read Only: true

  Maximum Length: 100

  The name of the associated entity.
• AssignedEntitySubTypeCode: string
  Title: Entity Subtype Code

  Read Only: true

  Maximum Length: 30

  The entity subtype code of the associated entity.
• AssignedEntitySubTypeMeaning: string
  Title: Entity Subtype

  Read Only: true

  Maximum Length: 80

  The entity subtype of the associated entity.
• AssignedEntityTypeCode: string
  Title: Entity Type Code

  Maximum Length: 30

  The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.
• AssignedEntityTypeMeaning: string
  Title: Entity Type

  Read Only: true

  Maximum Length: 80

  The entity type of the associated entity.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date the row was created.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description of the associated entity.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• SettingsAssignmentId: integer (int64)
  Title: Settings Assignment ID

  Read Only: true

  The unique identifier for the setup association record.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityName":{
            "title":"Entity Name",
            "maxLength":"100",
            "type":"string",
            "description":"The name of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SettingsAssignmentId":{
            "title":"Settings Assignment ID",
            "type":"integer",
            "description":"The unique identifier for the setup association record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityCode":{
            "title":"Entity Code",
            "maxLength":"100",
            "type":"string",
            "description":"The user defined identifier of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntitySubTypeCode":{
            "title":"Entity Subtype Code",
            "maxLength":"30",
            "type":"string",
            "description":"The entity subtype code of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityTypeMeaning":{
            "title":"Entity Type",
            "maxLength":"80",
            "type":"string",
            "description":"The entity type of the associated entity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityTypeCode":{
            "title":"Entity Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The entity type code of the associated entity. A list of accepted values is defined in the lookup type ORA_HER_ASSOCIATED_OBJECT_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AssignedEntitySubTypeMeaning":{
            "title":"Entity Subtype",
            "maxLength":"80",
            "type":"string",
            "description":"The entity subtype of the associated entity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedEntityId":{
            "title":"Entity ID",
            "type":"integer",
            "description":"The unique identifier of the associated entity.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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"
    }
}

Links

applicationStatuses

Operation: /fscmRestApi/resources/11.13.18.05/applicationSnapshotSettings/{SnapshotSetupId}/child/applicationStatuses

Parameters:

• SnapshotSetupId: $request.path.SnapshotSetupId

The application snapshot settings statuses resource stores the application statuses for which a snapshot of an application are taken.

assignments

Operation: /fscmRestApi/resources/11.13.18.05/applicationSnapshotSettings/{SnapshotSetupId}/child/assignments

Parameters:

• SnapshotSetupId: $request.path.SnapshotSetupId

The application snapshot settings assignments resource lists the academic entities assigned to this application snapshot settings instance.

Back to Top