Jump to

• Request
• Response

Create actions

post

/fscmRestApi/resources/11.13.18.05/collaborationDocumentDefinitions/{DocumentId}/child/documentActions

Request

Path Parameters

• DocumentId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

• ActionCode(required): string
  Maximum Length: 30

  Abbreviation that identifies the type of action for a document definition. A list of accepted values is defined in the lookup type ORA_VCS_DOC_ACTIONS.
• ActionName: string
  Name of the action for a document.
• documentActionParticipants: array Document Action Participants
  Title: Document Action Participants

  The Document Action Participants resource manages the participants associated with an action.

{
    "required":[
        "ActionCode"
    ],
    "type":"object",
    "properties":{
        "ActionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of action for a document definition. A list of accepted values is defined in the lookup type ORA_VCS_DOC_ACTIONS.",
            "nullable":false
        },
        "ActionName":{
            "type":"string",
            "description":"Name of the action for a document.",
            "nullable":true
        },
        "documentActionParticipants":{
            "title":"Document Action Participants",
            "type":"array",
            "description":"The Document Action Participants resource manages the participants associated with an action.",
            "items":{
                "$ref":"#/components/schemas/collaborationDocumentDefinitions-documentActions-documentActionParticipants-item-post-request"
            }
        }
    }
}

Nested Schema : Document Action Participants

Type: array

Title: Document Action Participants

The Document Action Participants resource manages the participants associated with an action.

Show Source

• Array of: object schema

{
    "title":"Document Action Participants",
    "type":"array",
    "description":"The Document Action Participants resource manages the participants associated with an action.",
    "items":{
        "$ref":"#/components/schemas/collaborationDocumentDefinitions-documentActions-documentActionParticipants-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• ParticipantCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of participant for an action. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE.
• ParticipantName: string
  Maximum Length: 255

  Name of the participant for an action.

{
    "type":"object",
    "properties":{
        "ParticipantName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the participant for an action.",
            "nullable":true
        },
        "ParticipantCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of participant for an action. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE.",
            "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 : collaborationDocumentDefinitions-documentActions-item-response

Type: object

Show Source

• ActionCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of action for a document definition. A list of accepted values is defined in the lookup type ORA_VCS_DOC_ACTIONS.
• ActionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the action for a document definition.
• ActionName: string
  Name of the action for a document.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the document action.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the document action.
• documentActionParticipants: array Document Action Participants
  Title: Document Action Participants

  The Document Action Participants resource manages the participants associated with an action.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the document action.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the document action.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the document action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the document action.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionName":{
            "type":"string",
            "description":"Name of the action for a document.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the action for a document definition.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the document action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "documentActionParticipants":{
            "title":"Document Action Participants",
            "type":"array",
            "description":"The Document Action Participants resource manages the participants associated with an action.",
            "items":{
                "$ref":"#/components/schemas/collaborationDocumentDefinitions-documentActions-documentActionParticipants-item-response"
            }
        },
        "ActionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of action for a document definition. A list of accepted values is defined in the lookup type ORA_VCS_DOC_ACTIONS.",
            "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":{
            "type":"string",
            "description":"Date and time when the user most recently updated the document action.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Document Action Participants

Type: array

Title: Document Action Participants

The Document Action Participants resource manages the participants associated with an action.

Show Source

• Array of: object collaborationDocumentDefinitions-documentActions-documentActionParticipants-item-response

{
    "title":"Document Action Participants",
    "type":"array",
    "description":"The Document Action Participants resource manages the participants associated with an action.",
    "items":{
        "$ref":"#/components/schemas/collaborationDocumentDefinitions-documentActions-documentActionParticipants-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 : collaborationDocumentDefinitions-documentActions-documentActionParticipants-item-response

Type: object

Show Source

• ActionId: integer (int64)
  Read Only: true

  Value that uniquely identifies the action for a document definition.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the document action participant.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the document action participant.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the document action participant.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the document action participant.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParticipantCode: string
  Maximum Length: 30

  Abbreviation that identifies the type of participant for an action. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE.
• ParticipantId: integer (int64)
  Read Only: true

  Value that uniquely identifies the participant for an action.
• ParticipantName: string
  Maximum Length: 255

  Name of the participant for an action.

{
    "type":"object",
    "properties":{
        "ParticipantId":{
            "type":"integer",
            "description":"Value that uniquely identifies the participant for an action.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the document action participant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the document action participant.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionId":{
            "type":"integer",
            "description":"Value that uniquely identifies the action for a document definition.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the document action participant.",
            "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"
            }
        },
        "ParticipantName":{
            "maxLength":"255",
            "type":"string",
            "description":"Name of the participant for an action.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the document action participant.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the type of participant for an action. Accepted values are ORA_VCS_CUSTOMER or ORA_VCS_ENTERPRISE.",
            "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."
        }
    }
}

Links

documentActionParticipants

Operation: /fscmRestApi/resources/11.13.18.05/collaborationDocumentDefinitions/{DocumentId}/child/documentActions/{ActionId}/child/documentActionParticipants

Parameters:

• ActionId: $request.path.ActionId
• DocumentId: $request.path.DocumentId

The Document Action Participants resource manages the participants associated with an action.

Back to Top